openapi: 3.0.0 servers: - url: https://demo.netbox.dev/api info: description: API to access NetBox license: name: Apache v2 License termsOfService: https://github.com/netbox-community/netbox title: NetBox API version: "3.4" x-apisguru-categories: - enterprise x-origin: - format: swagger url: https://demo.netbox.dev/api/docs/?format=openapi version: "2.0" x-providerName: netbox.dev security: - Bearer: [] paths: /circuits/circuit-terminations/: delete: description: "" operationId: circuits_circuit-terminations_bulk_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_circuit-terminations_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: term_side required: false schema: type: string - description: "" in: query name: port_speed required: false schema: type: string - description: "" in: query name: upstream_speed required: false schema: type: string - description: "" in: query name: xconnect_id required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: circuit_id required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: provider_network_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: term_side__n required: false schema: type: string - description: "" in: query name: port_speed__n required: false schema: type: string - description: "" in: query name: port_speed__lte required: false schema: type: string - description: "" in: query name: port_speed__lt required: false schema: type: string - description: "" in: query name: port_speed__gte required: false schema: type: string - description: "" in: query name: port_speed__gt required: false schema: type: string - description: "" in: query name: upstream_speed__n required: false schema: type: string - description: "" in: query name: upstream_speed__lte required: false schema: type: string - description: "" in: query name: upstream_speed__lt required: false schema: type: string - description: "" in: query name: upstream_speed__gte required: false schema: type: string - description: "" in: query name: upstream_speed__gt required: false schema: type: string - description: "" in: query name: xconnect_id__n required: false schema: type: string - description: "" in: query name: xconnect_id__ic required: false schema: type: string - description: "" in: query name: xconnect_id__nic required: false schema: type: string - description: "" in: query name: xconnect_id__iew required: false schema: type: string - description: "" in: query name: xconnect_id__niew required: false schema: type: string - description: "" in: query name: xconnect_id__isw required: false schema: type: string - description: "" in: query name: xconnect_id__nisw required: false schema: type: string - description: "" in: query name: xconnect_id__ie required: false schema: type: string - description: "" in: query name: xconnect_id__nie required: false schema: type: string - description: "" in: query name: xconnect_id__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: circuit_id__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: provider_network_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/CircuitTermination" type: array required: - count - results type: object description: "" tags: - circuits parameters: [] patch: description: "" operationId: circuits_circuit-terminations_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableCircuitTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits post: description: "" operationId: circuits_circuit-terminations_create requestBody: $ref: "#/components/requestBodies/WritableCircuitTermination" responses: "201": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits put: description: "" operationId: circuits_circuit-terminations_bulk_update requestBody: $ref: "#/components/requestBodies/WritableCircuitTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits "/circuits/circuit-terminations/{id}/": delete: description: "" operationId: circuits_circuit-terminations_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_circuit-terminations_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits parameters: - description: A unique integer value identifying this circuit termination. in: path name: id required: true schema: type: integer patch: description: "" operationId: circuits_circuit-terminations_partial_update requestBody: $ref: "#/components/requestBodies/WritableCircuitTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits put: description: "" operationId: circuits_circuit-terminations_update requestBody: $ref: "#/components/requestBodies/WritableCircuitTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits "/circuits/circuit-terminations/{id}/paths/": get: description: Return all CablePaths which traverse a given pass-through port. operationId: circuits_circuit-terminations_paths responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitTermination" description: "" tags: - circuits parameters: - description: A unique integer value identifying this circuit termination. in: path name: id required: true schema: type: integer /circuits/circuit-types/: delete: description: "" operationId: circuits_circuit-types_bulk_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_circuit-types_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/CircuitType" type: array required: - count - results type: object description: "" tags: - circuits parameters: [] patch: description: "" operationId: circuits_circuit-types_bulk_partial_update requestBody: $ref: "#/components/requestBodies/CircuitType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitType" description: "" tags: - circuits post: description: "" operationId: circuits_circuit-types_create requestBody: $ref: "#/components/requestBodies/CircuitType" responses: "201": content: application/json: schema: $ref: "#/components/schemas/CircuitType" description: "" tags: - circuits put: description: "" operationId: circuits_circuit-types_bulk_update requestBody: $ref: "#/components/requestBodies/CircuitType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitType" description: "" tags: - circuits "/circuits/circuit-types/{id}/": delete: description: "" operationId: circuits_circuit-types_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_circuit-types_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitType" description: "" tags: - circuits parameters: - description: A unique integer value identifying this circuit type. in: path name: id required: true schema: type: integer patch: description: "" operationId: circuits_circuit-types_partial_update requestBody: $ref: "#/components/requestBodies/CircuitType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitType" description: "" tags: - circuits put: description: "" operationId: circuits_circuit-types_update requestBody: $ref: "#/components/requestBodies/CircuitType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CircuitType" description: "" tags: - circuits /circuits/circuits/: delete: description: "" operationId: circuits_circuits_bulk_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_circuits_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: cid required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: install_date required: false schema: type: string - description: "" in: query name: termination_date required: false schema: type: string - description: "" in: query name: commit_rate required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: provider_id required: false schema: type: string - description: "" in: query name: provider required: false schema: type: string - description: "" in: query name: provider_network_id required: false schema: type: string - description: "" in: query name: type_id required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: cid__n required: false schema: type: string - description: "" in: query name: cid__ic required: false schema: type: string - description: "" in: query name: cid__nic required: false schema: type: string - description: "" in: query name: cid__iew required: false schema: type: string - description: "" in: query name: cid__niew required: false schema: type: string - description: "" in: query name: cid__isw required: false schema: type: string - description: "" in: query name: cid__nisw required: false schema: type: string - description: "" in: query name: cid__ie required: false schema: type: string - description: "" in: query name: cid__nie required: false schema: type: string - description: "" in: query name: cid__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: install_date__n required: false schema: type: string - description: "" in: query name: install_date__lte required: false schema: type: string - description: "" in: query name: install_date__lt required: false schema: type: string - description: "" in: query name: install_date__gte required: false schema: type: string - description: "" in: query name: install_date__gt required: false schema: type: string - description: "" in: query name: termination_date__n required: false schema: type: string - description: "" in: query name: termination_date__lte required: false schema: type: string - description: "" in: query name: termination_date__lt required: false schema: type: string - description: "" in: query name: termination_date__gte required: false schema: type: string - description: "" in: query name: termination_date__gt required: false schema: type: string - description: "" in: query name: commit_rate__n required: false schema: type: string - description: "" in: query name: commit_rate__lte required: false schema: type: string - description: "" in: query name: commit_rate__lt required: false schema: type: string - description: "" in: query name: commit_rate__gte required: false schema: type: string - description: "" in: query name: commit_rate__gt required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: provider_id__n required: false schema: type: string - description: "" in: query name: provider__n required: false schema: type: string - description: "" in: query name: provider_network_id__n required: false schema: type: string - description: "" in: query name: type_id__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Circuit" type: array required: - count - results type: object description: "" tags: - circuits parameters: [] patch: description: "" operationId: circuits_circuits_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableCircuit" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Circuit" description: "" tags: - circuits post: description: "" operationId: circuits_circuits_create requestBody: $ref: "#/components/requestBodies/WritableCircuit" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Circuit" description: "" tags: - circuits put: description: "" operationId: circuits_circuits_bulk_update requestBody: $ref: "#/components/requestBodies/WritableCircuit" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Circuit" description: "" tags: - circuits "/circuits/circuits/{id}/": delete: description: "" operationId: circuits_circuits_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_circuits_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Circuit" description: "" tags: - circuits parameters: - description: A unique integer value identifying this circuit. in: path name: id required: true schema: type: integer patch: description: "" operationId: circuits_circuits_partial_update requestBody: $ref: "#/components/requestBodies/WritableCircuit" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Circuit" description: "" tags: - circuits put: description: "" operationId: circuits_circuits_update requestBody: $ref: "#/components/requestBodies/WritableCircuit" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Circuit" description: "" tags: - circuits /circuits/provider-networks/: delete: description: "" operationId: circuits_provider-networks_bulk_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_provider-networks_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: service_id required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: provider_id required: false schema: type: string - description: "" in: query name: provider required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: service_id__n required: false schema: type: string - description: "" in: query name: service_id__ic required: false schema: type: string - description: "" in: query name: service_id__nic required: false schema: type: string - description: "" in: query name: service_id__iew required: false schema: type: string - description: "" in: query name: service_id__niew required: false schema: type: string - description: "" in: query name: service_id__isw required: false schema: type: string - description: "" in: query name: service_id__nisw required: false schema: type: string - description: "" in: query name: service_id__ie required: false schema: type: string - description: "" in: query name: service_id__nie required: false schema: type: string - description: "" in: query name: service_id__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: provider_id__n required: false schema: type: string - description: "" in: query name: provider__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ProviderNetwork" type: array required: - count - results type: object description: "" tags: - circuits parameters: [] patch: description: "" operationId: circuits_provider-networks_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableProviderNetwork" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProviderNetwork" description: "" tags: - circuits post: description: "" operationId: circuits_provider-networks_create requestBody: $ref: "#/components/requestBodies/WritableProviderNetwork" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ProviderNetwork" description: "" tags: - circuits put: description: "" operationId: circuits_provider-networks_bulk_update requestBody: $ref: "#/components/requestBodies/WritableProviderNetwork" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProviderNetwork" description: "" tags: - circuits "/circuits/provider-networks/{id}/": delete: description: "" operationId: circuits_provider-networks_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_provider-networks_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProviderNetwork" description: "" tags: - circuits parameters: - description: A unique integer value identifying this provider network. in: path name: id required: true schema: type: integer patch: description: "" operationId: circuits_provider-networks_partial_update requestBody: $ref: "#/components/requestBodies/WritableProviderNetwork" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProviderNetwork" description: "" tags: - circuits put: description: "" operationId: circuits_provider-networks_update requestBody: $ref: "#/components/requestBodies/WritableProviderNetwork" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProviderNetwork" description: "" tags: - circuits /circuits/providers/: delete: description: "" operationId: circuits_providers_bulk_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_providers_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: account required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: asn_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: account__n required: false schema: type: string - description: "" in: query name: account__ic required: false schema: type: string - description: "" in: query name: account__nic required: false schema: type: string - description: "" in: query name: account__iew required: false schema: type: string - description: "" in: query name: account__niew required: false schema: type: string - description: "" in: query name: account__isw required: false schema: type: string - description: "" in: query name: account__nisw required: false schema: type: string - description: "" in: query name: account__ie required: false schema: type: string - description: "" in: query name: account__nie required: false schema: type: string - description: "" in: query name: account__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: asn_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Provider" type: array required: - count - results type: object description: "" tags: - circuits parameters: [] patch: description: "" operationId: circuits_providers_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableProvider" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Provider" description: "" tags: - circuits post: description: "" operationId: circuits_providers_create requestBody: $ref: "#/components/requestBodies/WritableProvider" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Provider" description: "" tags: - circuits put: description: "" operationId: circuits_providers_bulk_update requestBody: $ref: "#/components/requestBodies/WritableProvider" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Provider" description: "" tags: - circuits "/circuits/providers/{id}/": delete: description: "" operationId: circuits_providers_delete responses: "204": description: "" tags: - circuits get: description: "" operationId: circuits_providers_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Provider" description: "" tags: - circuits parameters: - description: A unique integer value identifying this provider. in: path name: id required: true schema: type: integer patch: description: "" operationId: circuits_providers_partial_update requestBody: $ref: "#/components/requestBodies/WritableProvider" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Provider" description: "" tags: - circuits put: description: "" operationId: circuits_providers_update requestBody: $ref: "#/components/requestBodies/WritableProvider" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Provider" description: "" tags: - circuits /dcim/cable-terminations/: delete: description: "" operationId: dcim_cable-terminations_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_cable-terminations_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: cable required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: termination_type required: false schema: type: string - description: "" in: query name: termination_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: cable__n required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: termination_type__n required: false schema: type: string - description: "" in: query name: termination_id__n required: false schema: type: string - description: "" in: query name: termination_id__lte required: false schema: type: string - description: "" in: query name: termination_id__lt required: false schema: type: string - description: "" in: query name: termination_id__gte required: false schema: type: string - description: "" in: query name: termination_id__gt required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/CableTermination" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_cable-terminations_bulk_partial_update requestBody: $ref: "#/components/requestBodies/CableTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CableTermination" description: "" tags: - dcim post: description: "" operationId: dcim_cable-terminations_create requestBody: $ref: "#/components/requestBodies/CableTermination" responses: "201": content: application/json: schema: $ref: "#/components/schemas/CableTermination" description: "" tags: - dcim put: description: "" operationId: dcim_cable-terminations_bulk_update requestBody: $ref: "#/components/requestBodies/CableTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CableTermination" description: "" tags: - dcim "/dcim/cable-terminations/{id}/": delete: description: "" operationId: dcim_cable-terminations_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_cable-terminations_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/CableTermination" description: "" tags: - dcim parameters: - description: A unique integer value identifying this cable termination. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_cable-terminations_partial_update requestBody: $ref: "#/components/requestBodies/CableTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CableTermination" description: "" tags: - dcim put: description: "" operationId: dcim_cable-terminations_update requestBody: $ref: "#/components/requestBodies/CableTermination" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CableTermination" description: "" tags: - dcim /dcim/cables/: delete: description: "" operationId: dcim_cables_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_cables_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: length required: false schema: type: string - description: "" in: query name: length_unit required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: termination_a_type required: false schema: type: string - description: "" in: query name: termination_a_id required: false schema: type: string - description: "" in: query name: termination_b_type required: false schema: type: string - description: "" in: query name: termination_b_id required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: length__n required: false schema: type: string - description: "" in: query name: length__lte required: false schema: type: string - description: "" in: query name: length__lt required: false schema: type: string - description: "" in: query name: length__gte required: false schema: type: string - description: "" in: query name: length__gt required: false schema: type: string - description: "" in: query name: length_unit__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: termination_a_type__n required: false schema: type: string - description: "" in: query name: termination_a_id__n required: false schema: type: string - description: "" in: query name: termination_a_id__lte required: false schema: type: string - description: "" in: query name: termination_a_id__lt required: false schema: type: string - description: "" in: query name: termination_a_id__gte required: false schema: type: string - description: "" in: query name: termination_a_id__gt required: false schema: type: string - description: "" in: query name: termination_b_type__n required: false schema: type: string - description: "" in: query name: termination_b_id__n required: false schema: type: string - description: "" in: query name: termination_b_id__lte required: false schema: type: string - description: "" in: query name: termination_b_id__lt required: false schema: type: string - description: "" in: query name: termination_b_id__gte required: false schema: type: string - description: "" in: query name: termination_b_id__gt required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Cable" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_cables_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableCable" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Cable" description: "" tags: - dcim post: description: "" operationId: dcim_cables_create requestBody: $ref: "#/components/requestBodies/WritableCable" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Cable" description: "" tags: - dcim put: description: "" operationId: dcim_cables_bulk_update requestBody: $ref: "#/components/requestBodies/WritableCable" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Cable" description: "" tags: - dcim "/dcim/cables/{id}/": delete: description: "" operationId: dcim_cables_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_cables_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Cable" description: "" tags: - dcim parameters: - description: A unique integer value identifying this cable. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_cables_partial_update requestBody: $ref: "#/components/requestBodies/WritableCable" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Cable" description: "" tags: - dcim put: description: "" operationId: dcim_cables_update requestBody: $ref: "#/components/requestBodies/WritableCable" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Cable" description: "" tags: - dcim /dcim/connected-device/: get: description: |- This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors via a protocol such as LLDP. Two query parameters must be included in the request: * `peer_device`: The name of the peer device * `peer_interface`: The name of the peer interface operationId: dcim_connected-device_list parameters: - description: The name of the peer device in: query name: peer_device required: true schema: type: string - description: The name of the peer interface in: query name: peer_interface required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Device" description: "" tags: - dcim parameters: [] /dcim/console-port-templates/: delete: description: "" operationId: dcim_console-port-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-port-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ConsolePortTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_console-port-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsolePortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePortTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_console-port-templates_create requestBody: $ref: "#/components/requestBodies/WritableConsolePortTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ConsolePortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_console-port-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableConsolePortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePortTemplate" description: "" tags: - dcim "/dcim/console-port-templates/{id}/": delete: description: "" operationId: dcim_console-port-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-port-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePortTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this console port template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_console-port-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsolePortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_console-port-templates_update requestBody: $ref: "#/components/requestBodies/WritableConsolePortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePortTemplate" description: "" tags: - dcim /dcim/console-ports/: delete: description: "" operationId: dcim_console-ports_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-ports_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: connected required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ConsolePort" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_console-ports_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsolePort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim post: description: "" operationId: dcim_console-ports_create requestBody: $ref: "#/components/requestBodies/WritableConsolePort" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim put: description: "" operationId: dcim_console-ports_bulk_update requestBody: $ref: "#/components/requestBodies/WritableConsolePort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim "/dcim/console-ports/{id}/": delete: description: "" operationId: dcim_console-ports_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-ports_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this console port. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_console-ports_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsolePort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim put: description: "" operationId: dcim_console-ports_update requestBody: $ref: "#/components/requestBodies/WritableConsolePort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim "/dcim/console-ports/{id}/trace/": get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_console-ports_trace responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsolePort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this console port. in: path name: id required: true schema: type: integer /dcim/console-server-port-templates/: delete: description: "" operationId: dcim_console-server-port-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-server-port-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ConsoleServerPortTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_console-server-port-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPortTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_console-server-port-templates_create requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPortTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_console-server-port-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPortTemplate" description: "" tags: - dcim "/dcim/console-server-port-templates/{id}/": delete: description: "" operationId: dcim_console-server-port-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-server-port-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPortTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this console server port template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_console-server-port-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_console-server-port-templates_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPortTemplate" description: "" tags: - dcim /dcim/console-server-ports/: delete: description: "" operationId: dcim_console-server-ports_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-server-ports_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: connected required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ConsoleServerPort" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_console-server-ports_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim post: description: "" operationId: dcim_console-server-ports_create requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPort" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim put: description: "" operationId: dcim_console-server-ports_bulk_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim "/dcim/console-server-ports/{id}/": delete: description: "" operationId: dcim_console-server-ports_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_console-server-ports_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this console server port. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_console-server-ports_partial_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim put: description: "" operationId: dcim_console-server-ports_update requestBody: $ref: "#/components/requestBodies/WritableConsoleServerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim "/dcim/console-server-ports/{id}/trace/": get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_console-server-ports_trace responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConsoleServerPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this console server port. in: path name: id required: true schema: type: integer /dcim/device-bay-templates/: delete: description: "" operationId: dcim_device-bay-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-bay-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/DeviceBayTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_device-bay-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBayTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_device-bay-templates_create requestBody: $ref: "#/components/requestBodies/WritableDeviceBayTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/DeviceBayTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_device-bay-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBayTemplate" description: "" tags: - dcim "/dcim/device-bay-templates/{id}/": delete: description: "" operationId: dcim_device-bay-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-bay-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBayTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this device bay template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_device-bay-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBayTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_device-bay-templates_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBayTemplate" description: "" tags: - dcim /dcim/device-bays/: delete: description: "" operationId: dcim_device-bays_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-bays_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/DeviceBay" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_device-bays_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBay" description: "" tags: - dcim post: description: "" operationId: dcim_device-bays_create requestBody: $ref: "#/components/requestBodies/WritableDeviceBay" responses: "201": content: application/json: schema: $ref: "#/components/schemas/DeviceBay" description: "" tags: - dcim put: description: "" operationId: dcim_device-bays_bulk_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBay" description: "" tags: - dcim "/dcim/device-bays/{id}/": delete: description: "" operationId: dcim_device-bays_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-bays_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBay" description: "" tags: - dcim parameters: - description: A unique integer value identifying this device bay. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_device-bays_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBay" description: "" tags: - dcim put: description: "" operationId: dcim_device-bays_update requestBody: $ref: "#/components/requestBodies/WritableDeviceBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceBay" description: "" tags: - dcim /dcim/device-roles/: delete: description: "" operationId: dcim_device-roles_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-roles_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: vm_role required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/DeviceRole" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_device-roles_bulk_partial_update requestBody: $ref: "#/components/requestBodies/DeviceRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceRole" description: "" tags: - dcim post: description: "" operationId: dcim_device-roles_create requestBody: $ref: "#/components/requestBodies/DeviceRole" responses: "201": content: application/json: schema: $ref: "#/components/schemas/DeviceRole" description: "" tags: - dcim put: description: "" operationId: dcim_device-roles_bulk_update requestBody: $ref: "#/components/requestBodies/DeviceRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceRole" description: "" tags: - dcim "/dcim/device-roles/{id}/": delete: description: "" operationId: dcim_device-roles_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-roles_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceRole" description: "" tags: - dcim parameters: - description: A unique integer value identifying this device role. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_device-roles_partial_update requestBody: $ref: "#/components/requestBodies/DeviceRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceRole" description: "" tags: - dcim put: description: "" operationId: dcim_device-roles_update requestBody: $ref: "#/components/requestBodies/DeviceRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceRole" description: "" tags: - dcim /dcim/device-types/: delete: description: "" operationId: dcim_device-types_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-types_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: model required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: part_number required: false schema: type: string - description: "" in: query name: u_height required: false schema: type: string - description: "" in: query name: is_full_depth required: false schema: type: string - description: "" in: query name: subdevice_role required: false schema: type: string - description: "" in: query name: airflow required: false schema: type: string - description: "" in: query name: weight required: false schema: type: string - description: "" in: query name: weight_unit required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: has_front_image required: false schema: type: string - description: "" in: query name: has_rear_image required: false schema: type: string - description: "" in: query name: console_ports required: false schema: type: string - description: "" in: query name: console_server_ports required: false schema: type: string - description: "" in: query name: power_ports required: false schema: type: string - description: "" in: query name: power_outlets required: false schema: type: string - description: "" in: query name: interfaces required: false schema: type: string - description: "" in: query name: pass_through_ports required: false schema: type: string - description: "" in: query name: module_bays required: false schema: type: string - description: "" in: query name: device_bays required: false schema: type: string - description: "" in: query name: inventory_items required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: model__n required: false schema: type: string - description: "" in: query name: model__ic required: false schema: type: string - description: "" in: query name: model__nic required: false schema: type: string - description: "" in: query name: model__iew required: false schema: type: string - description: "" in: query name: model__niew required: false schema: type: string - description: "" in: query name: model__isw required: false schema: type: string - description: "" in: query name: model__nisw required: false schema: type: string - description: "" in: query name: model__ie required: false schema: type: string - description: "" in: query name: model__nie required: false schema: type: string - description: "" in: query name: model__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: part_number__n required: false schema: type: string - description: "" in: query name: part_number__ic required: false schema: type: string - description: "" in: query name: part_number__nic required: false schema: type: string - description: "" in: query name: part_number__iew required: false schema: type: string - description: "" in: query name: part_number__niew required: false schema: type: string - description: "" in: query name: part_number__isw required: false schema: type: string - description: "" in: query name: part_number__nisw required: false schema: type: string - description: "" in: query name: part_number__ie required: false schema: type: string - description: "" in: query name: part_number__nie required: false schema: type: string - description: "" in: query name: part_number__empty required: false schema: type: string - description: "" in: query name: u_height__n required: false schema: type: string - description: "" in: query name: u_height__lte required: false schema: type: string - description: "" in: query name: u_height__lt required: false schema: type: string - description: "" in: query name: u_height__gte required: false schema: type: string - description: "" in: query name: u_height__gt required: false schema: type: string - description: "" in: query name: subdevice_role__n required: false schema: type: string - description: "" in: query name: airflow__n required: false schema: type: string - description: "" in: query name: weight__n required: false schema: type: string - description: "" in: query name: weight__lte required: false schema: type: string - description: "" in: query name: weight__lt required: false schema: type: string - description: "" in: query name: weight__gte required: false schema: type: string - description: "" in: query name: weight__gt required: false schema: type: string - description: "" in: query name: weight_unit__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/DeviceType" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_device-types_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceType" description: "" tags: - dcim post: description: "" operationId: dcim_device-types_create requestBody: $ref: "#/components/requestBodies/WritableDeviceType" responses: "201": content: application/json: schema: $ref: "#/components/schemas/DeviceType" description: "" tags: - dcim put: description: "" operationId: dcim_device-types_bulk_update requestBody: $ref: "#/components/requestBodies/WritableDeviceType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceType" description: "" tags: - dcim "/dcim/device-types/{id}/": delete: description: "" operationId: dcim_device-types_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_device-types_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceType" description: "" tags: - dcim parameters: - description: A unique integer value identifying this device type. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_device-types_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceType" description: "" tags: - dcim put: description: "" operationId: dcim_device-types_update requestBody: $ref: "#/components/requestBodies/WritableDeviceType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceType" description: "" tags: - dcim /dcim/devices/: delete: description: "" operationId: dcim_devices_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_devices_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: asset_tag required: false schema: type: string - description: "" in: query name: face required: false schema: type: string - description: "" in: query name: position required: false schema: type: string - description: "" in: query name: airflow required: false schema: type: string - description: "" in: query name: vc_position required: false schema: type: string - description: "" in: query name: vc_priority required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: local_context_data required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: device_type required: false schema: type: string - description: "" in: query name: device_type_id required: false schema: type: string - description: "" in: query name: role_id required: false schema: type: string - description: "" in: query name: role required: false schema: type: string - description: "" in: query name: parent_device_id required: false schema: type: string - description: "" in: query name: platform_id required: false schema: type: string - description: "" in: query name: platform required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: cluster_id required: false schema: type: string - description: "" in: query name: model required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: is_full_depth required: false schema: type: string - description: "" in: query name: mac_address required: false schema: type: string - description: "" in: query name: serial required: false schema: type: string - description: "" in: query name: has_primary_ip required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis_member required: false schema: type: string - description: "" in: query name: console_ports required: false schema: type: string - description: "" in: query name: console_server_ports required: false schema: type: string - description: "" in: query name: power_ports required: false schema: type: string - description: "" in: query name: power_outlets required: false schema: type: string - description: "" in: query name: interfaces required: false schema: type: string - description: "" in: query name: pass_through_ports required: false schema: type: string - description: "" in: query name: module_bays required: false schema: type: string - description: "" in: query name: device_bays required: false schema: type: string - description: "" in: query name: primary_ip4_id required: false schema: type: string - description: "" in: query name: primary_ip6_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: asset_tag__n required: false schema: type: string - description: "" in: query name: asset_tag__ic required: false schema: type: string - description: "" in: query name: asset_tag__nic required: false schema: type: string - description: "" in: query name: asset_tag__iew required: false schema: type: string - description: "" in: query name: asset_tag__niew required: false schema: type: string - description: "" in: query name: asset_tag__isw required: false schema: type: string - description: "" in: query name: asset_tag__nisw required: false schema: type: string - description: "" in: query name: asset_tag__ie required: false schema: type: string - description: "" in: query name: asset_tag__nie required: false schema: type: string - description: "" in: query name: asset_tag__empty required: false schema: type: string - description: "" in: query name: face__n required: false schema: type: string - description: "" in: query name: position__n required: false schema: type: string - description: "" in: query name: position__lte required: false schema: type: string - description: "" in: query name: position__lt required: false schema: type: string - description: "" in: query name: position__gte required: false schema: type: string - description: "" in: query name: position__gt required: false schema: type: string - description: "" in: query name: airflow__n required: false schema: type: string - description: "" in: query name: vc_position__n required: false schema: type: string - description: "" in: query name: vc_position__lte required: false schema: type: string - description: "" in: query name: vc_position__lt required: false schema: type: string - description: "" in: query name: vc_position__gte required: false schema: type: string - description: "" in: query name: vc_position__gt required: false schema: type: string - description: "" in: query name: vc_priority__n required: false schema: type: string - description: "" in: query name: vc_priority__lte required: false schema: type: string - description: "" in: query name: vc_priority__lt required: false schema: type: string - description: "" in: query name: vc_priority__gte required: false schema: type: string - description: "" in: query name: vc_priority__gt required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: "" in: query name: device_type__n required: false schema: type: string - description: "" in: query name: device_type_id__n required: false schema: type: string - description: "" in: query name: role_id__n required: false schema: type: string - description: "" in: query name: role__n required: false schema: type: string - description: "" in: query name: parent_device_id__n required: false schema: type: string - description: "" in: query name: platform_id__n required: false schema: type: string - description: "" in: query name: platform__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: cluster_id__n required: false schema: type: string - description: "" in: query name: model__n required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: mac_address__n required: false schema: type: string - description: "" in: query name: mac_address__ic required: false schema: type: string - description: "" in: query name: mac_address__nic required: false schema: type: string - description: "" in: query name: mac_address__iew required: false schema: type: string - description: "" in: query name: mac_address__niew required: false schema: type: string - description: "" in: query name: mac_address__isw required: false schema: type: string - description: "" in: query name: mac_address__nisw required: false schema: type: string - description: "" in: query name: mac_address__ie required: false schema: type: string - description: "" in: query name: mac_address__nie required: false schema: type: string - description: "" in: query name: serial__n required: false schema: type: string - description: "" in: query name: serial__ic required: false schema: type: string - description: "" in: query name: serial__nic required: false schema: type: string - description: "" in: query name: serial__iew required: false schema: type: string - description: "" in: query name: serial__niew required: false schema: type: string - description: "" in: query name: serial__isw required: false schema: type: string - description: "" in: query name: serial__nisw required: false schema: type: string - description: "" in: query name: serial__ie required: false schema: type: string - description: "" in: query name: serial__nie required: false schema: type: string - description: "" in: query name: serial__empty required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: primary_ip4_id__n required: false schema: type: string - description: "" in: query name: primary_ip6_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/DeviceWithConfigContext" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_devices_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceWithConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceWithConfigContext" description: "" tags: - dcim post: description: "" operationId: dcim_devices_create requestBody: $ref: "#/components/requestBodies/WritableDeviceWithConfigContext" responses: "201": content: application/json: schema: $ref: "#/components/schemas/DeviceWithConfigContext" description: "" tags: - dcim put: description: "" operationId: dcim_devices_bulk_update requestBody: $ref: "#/components/requestBodies/WritableDeviceWithConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceWithConfigContext" description: "" tags: - dcim "/dcim/devices/{id}/": delete: description: "" operationId: dcim_devices_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_devices_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceWithConfigContext" description: "" tags: - dcim parameters: - description: A unique integer value identifying this device. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_devices_partial_update requestBody: $ref: "#/components/requestBodies/WritableDeviceWithConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceWithConfigContext" description: "" tags: - dcim put: description: "" operationId: dcim_devices_update requestBody: $ref: "#/components/requestBodies/WritableDeviceWithConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceWithConfigContext" description: "" tags: - dcim "/dcim/devices/{id}/napalm/": get: description: Execute a NAPALM method on a Device operationId: dcim_devices_napalm parameters: - in: query name: method required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/DeviceNAPALM" description: "" tags: - dcim parameters: - description: A unique integer value identifying this device. in: path name: id required: true schema: type: integer /dcim/front-port-templates/: delete: description: "" operationId: dcim_front-port-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_front-port-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/FrontPortTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_front-port-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableFrontPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPortTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_front-port-templates_create requestBody: $ref: "#/components/requestBodies/WritableFrontPortTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/FrontPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_front-port-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableFrontPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPortTemplate" description: "" tags: - dcim "/dcim/front-port-templates/{id}/": delete: description: "" operationId: dcim_front-port-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_front-port-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPortTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this front port template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_front-port-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableFrontPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_front-port-templates_update requestBody: $ref: "#/components/requestBodies/WritableFrontPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPortTemplate" description: "" tags: - dcim /dcim/front-ports/: delete: description: "" operationId: dcim_front-ports_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_front-ports_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/FrontPort" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_front-ports_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableFrontPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim post: description: "" operationId: dcim_front-ports_create requestBody: $ref: "#/components/requestBodies/WritableFrontPort" responses: "201": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim put: description: "" operationId: dcim_front-ports_bulk_update requestBody: $ref: "#/components/requestBodies/WritableFrontPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim "/dcim/front-ports/{id}/": delete: description: "" operationId: dcim_front-ports_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_front-ports_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this front port. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_front-ports_partial_update requestBody: $ref: "#/components/requestBodies/WritableFrontPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim put: description: "" operationId: dcim_front-ports_update requestBody: $ref: "#/components/requestBodies/WritableFrontPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim "/dcim/front-ports/{id}/paths/": get: description: Return all CablePaths which traverse a given pass-through port. operationId: dcim_front-ports_paths responses: "200": content: application/json: schema: $ref: "#/components/schemas/FrontPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this front port. in: path name: id required: true schema: type: integer /dcim/interface-templates/: delete: description: "" operationId: dcim_interface-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_interface-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: mgmt_only required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: poe_mode required: false schema: type: string - description: "" in: query name: poe_type required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: "" in: query name: poe_mode__n required: false schema: type: string - description: "" in: query name: poe_type__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/InterfaceTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_interface-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableInterfaceTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InterfaceTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_interface-templates_create requestBody: $ref: "#/components/requestBodies/WritableInterfaceTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/InterfaceTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_interface-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableInterfaceTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InterfaceTemplate" description: "" tags: - dcim "/dcim/interface-templates/{id}/": delete: description: "" operationId: dcim_interface-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_interface-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/InterfaceTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this interface template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_interface-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableInterfaceTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InterfaceTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_interface-templates_update requestBody: $ref: "#/components/requestBodies/WritableInterfaceTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InterfaceTemplate" description: "" tags: - dcim /dcim/interfaces/: delete: description: "" operationId: dcim_interfaces_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_interfaces_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: enabled required: false schema: type: string - description: "" in: query name: mtu required: false schema: type: string - description: "" in: query name: mgmt_only required: false schema: type: string - description: "" in: query name: poe_mode required: false schema: type: string - description: "" in: query name: poe_type required: false schema: type: string - description: "" in: query name: mode required: false schema: type: string - description: "" in: query name: rf_role required: false schema: type: string - description: "" in: query name: rf_channel required: false schema: type: string - description: "" in: query name: rf_channel_frequency required: false schema: type: string - description: "" in: query name: rf_channel_width required: false schema: type: string - description: "" in: query name: tx_power required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: connected required: false schema: type: string - description: "" in: query name: kind required: false schema: type: string - description: "" in: query name: parent_id required: false schema: type: string - description: "" in: query name: bridge_id required: false schema: type: string - description: "" in: query name: lag_id required: false schema: type: string - description: "" in: query name: speed required: false schema: type: string - description: "" in: query name: duplex required: false schema: type: string - description: "" in: query name: mac_address required: false schema: type: string - description: "" in: query name: wwn required: false schema: type: string - description: "" in: query name: vlan_id required: false schema: type: string - description: "" in: query name: vlan required: false schema: type: string - description: "" in: query name: vrf_id required: false schema: type: string - description: "" in: query name: vrf required: false schema: type: string - description: "" in: query name: vdc_id required: false schema: type: string - description: "" in: query name: vdc_identifier required: false schema: type: string - description: "" in: query name: vdc required: false schema: type: string - description: "" in: query name: l2vpn_id required: false schema: type: string - description: "" in: query name: l2vpn required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: mtu__n required: false schema: type: string - description: "" in: query name: mtu__lte required: false schema: type: string - description: "" in: query name: mtu__lt required: false schema: type: string - description: "" in: query name: mtu__gte required: false schema: type: string - description: "" in: query name: mtu__gt required: false schema: type: string - description: "" in: query name: poe_mode__n required: false schema: type: string - description: "" in: query name: poe_type__n required: false schema: type: string - description: "" in: query name: mode__n required: false schema: type: string - description: "" in: query name: rf_role__n required: false schema: type: string - description: "" in: query name: rf_channel__n required: false schema: type: string - description: "" in: query name: rf_channel_frequency__n required: false schema: type: string - description: "" in: query name: rf_channel_frequency__lte required: false schema: type: string - description: "" in: query name: rf_channel_frequency__lt required: false schema: type: string - description: "" in: query name: rf_channel_frequency__gte required: false schema: type: string - description: "" in: query name: rf_channel_frequency__gt required: false schema: type: string - description: "" in: query name: rf_channel_width__n required: false schema: type: string - description: "" in: query name: rf_channel_width__lte required: false schema: type: string - description: "" in: query name: rf_channel_width__lt required: false schema: type: string - description: "" in: query name: rf_channel_width__gte required: false schema: type: string - description: "" in: query name: rf_channel_width__gt required: false schema: type: string - description: "" in: query name: tx_power__n required: false schema: type: string - description: "" in: query name: tx_power__lte required: false schema: type: string - description: "" in: query name: tx_power__lt required: false schema: type: string - description: "" in: query name: tx_power__gte required: false schema: type: string - description: "" in: query name: tx_power__gt required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: parent_id__n required: false schema: type: string - description: "" in: query name: bridge_id__n required: false schema: type: string - description: "" in: query name: lag_id__n required: false schema: type: string - description: "" in: query name: speed__n required: false schema: type: string - description: "" in: query name: speed__lte required: false schema: type: string - description: "" in: query name: speed__lt required: false schema: type: string - description: "" in: query name: speed__gte required: false schema: type: string - description: "" in: query name: speed__gt required: false schema: type: string - description: "" in: query name: duplex__n required: false schema: type: string - description: "" in: query name: mac_address__n required: false schema: type: string - description: "" in: query name: mac_address__ic required: false schema: type: string - description: "" in: query name: mac_address__nic required: false schema: type: string - description: "" in: query name: mac_address__iew required: false schema: type: string - description: "" in: query name: mac_address__niew required: false schema: type: string - description: "" in: query name: mac_address__isw required: false schema: type: string - description: "" in: query name: mac_address__nisw required: false schema: type: string - description: "" in: query name: mac_address__ie required: false schema: type: string - description: "" in: query name: mac_address__nie required: false schema: type: string - description: "" in: query name: wwn__n required: false schema: type: string - description: "" in: query name: wwn__ic required: false schema: type: string - description: "" in: query name: wwn__nic required: false schema: type: string - description: "" in: query name: wwn__iew required: false schema: type: string - description: "" in: query name: wwn__niew required: false schema: type: string - description: "" in: query name: wwn__isw required: false schema: type: string - description: "" in: query name: wwn__nisw required: false schema: type: string - description: "" in: query name: wwn__ie required: false schema: type: string - description: "" in: query name: wwn__nie required: false schema: type: string - description: "" in: query name: vrf_id__n required: false schema: type: string - description: "" in: query name: vrf__n required: false schema: type: string - description: "" in: query name: vdc_id__n required: false schema: type: string - description: "" in: query name: vdc_identifier__n required: false schema: type: string - description: "" in: query name: vdc__n required: false schema: type: string - description: "" in: query name: l2vpn_id__n required: false schema: type: string - description: "" in: query name: l2vpn__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Interface" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_interfaces_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableInterface" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim post: description: "" operationId: dcim_interfaces_create requestBody: $ref: "#/components/requestBodies/WritableInterface" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim put: description: "" operationId: dcim_interfaces_bulk_update requestBody: $ref: "#/components/requestBodies/WritableInterface" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim "/dcim/interfaces/{id}/": delete: description: "" operationId: dcim_interfaces_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_interfaces_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim parameters: - description: A unique integer value identifying this interface. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_interfaces_partial_update requestBody: $ref: "#/components/requestBodies/WritableInterface" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim put: description: "" operationId: dcim_interfaces_update requestBody: $ref: "#/components/requestBodies/WritableInterface" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim "/dcim/interfaces/{id}/trace/": get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_interfaces_trace responses: "200": content: application/json: schema: $ref: "#/components/schemas/Interface" description: "" tags: - dcim parameters: - description: A unique integer value identifying this interface. in: path name: id required: true schema: type: integer /dcim/inventory-item-roles/: delete: description: "" operationId: dcim_inventory-item-roles_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_inventory-item-roles_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/InventoryItemRole" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_inventory-item-roles_bulk_partial_update requestBody: $ref: "#/components/requestBodies/InventoryItemRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemRole" description: "" tags: - dcim post: description: "" operationId: dcim_inventory-item-roles_create requestBody: $ref: "#/components/requestBodies/InventoryItemRole" responses: "201": content: application/json: schema: $ref: "#/components/schemas/InventoryItemRole" description: "" tags: - dcim put: description: "" operationId: dcim_inventory-item-roles_bulk_update requestBody: $ref: "#/components/requestBodies/InventoryItemRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemRole" description: "" tags: - dcim "/dcim/inventory-item-roles/{id}/": delete: description: "" operationId: dcim_inventory-item-roles_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_inventory-item-roles_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemRole" description: "" tags: - dcim parameters: - description: A unique integer value identifying this inventory item role. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_inventory-item-roles_partial_update requestBody: $ref: "#/components/requestBodies/InventoryItemRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemRole" description: "" tags: - dcim put: description: "" operationId: dcim_inventory-item-roles_update requestBody: $ref: "#/components/requestBodies/InventoryItemRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemRole" description: "" tags: - dcim /dcim/inventory-item-templates/: delete: description: "" operationId: dcim_inventory-item-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_inventory-item-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: part_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: parent_id required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: role_id required: false schema: type: string - description: "" in: query name: role required: false schema: type: string - description: "" in: query name: component_type required: false schema: type: string - description: "" in: query name: component_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: part_id__n required: false schema: type: string - description: "" in: query name: part_id__ic required: false schema: type: string - description: "" in: query name: part_id__nic required: false schema: type: string - description: "" in: query name: part_id__iew required: false schema: type: string - description: "" in: query name: part_id__niew required: false schema: type: string - description: "" in: query name: part_id__isw required: false schema: type: string - description: "" in: query name: part_id__nisw required: false schema: type: string - description: "" in: query name: part_id__ie required: false schema: type: string - description: "" in: query name: part_id__nie required: false schema: type: string - description: "" in: query name: part_id__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: parent_id__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: "" in: query name: role_id__n required: false schema: type: string - description: "" in: query name: role__n required: false schema: type: string - description: "" in: query name: component_type__n required: false schema: type: string - description: "" in: query name: component_id__n required: false schema: type: string - description: "" in: query name: component_id__lte required: false schema: type: string - description: "" in: query name: component_id__lt required: false schema: type: string - description: "" in: query name: component_id__gte required: false schema: type: string - description: "" in: query name: component_id__gt required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/InventoryItemTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_inventory-item-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItemTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_inventory-item-templates_create requestBody: $ref: "#/components/requestBodies/WritableInventoryItemTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/InventoryItemTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_inventory-item-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItemTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemTemplate" description: "" tags: - dcim "/dcim/inventory-item-templates/{id}/": delete: description: "" operationId: dcim_inventory-item-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_inventory-item-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this inventory item template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_inventory-item-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItemTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_inventory-item-templates_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItemTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItemTemplate" description: "" tags: - dcim /dcim/inventory-items/: delete: description: "" operationId: dcim_inventory-items_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_inventory-items_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: part_id required: false schema: type: string - description: "" in: query name: asset_tag required: false schema: type: string - description: "" in: query name: discovered required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: parent_id required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: role_id required: false schema: type: string - description: "" in: query name: role required: false schema: type: string - description: "" in: query name: component_type required: false schema: type: string - description: "" in: query name: component_id required: false schema: type: string - description: "" in: query name: serial required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: part_id__n required: false schema: type: string - description: "" in: query name: part_id__ic required: false schema: type: string - description: "" in: query name: part_id__nic required: false schema: type: string - description: "" in: query name: part_id__iew required: false schema: type: string - description: "" in: query name: part_id__niew required: false schema: type: string - description: "" in: query name: part_id__isw required: false schema: type: string - description: "" in: query name: part_id__nisw required: false schema: type: string - description: "" in: query name: part_id__ie required: false schema: type: string - description: "" in: query name: part_id__nie required: false schema: type: string - description: "" in: query name: part_id__empty required: false schema: type: string - description: "" in: query name: asset_tag__n required: false schema: type: string - description: "" in: query name: asset_tag__ic required: false schema: type: string - description: "" in: query name: asset_tag__nic required: false schema: type: string - description: "" in: query name: asset_tag__iew required: false schema: type: string - description: "" in: query name: asset_tag__niew required: false schema: type: string - description: "" in: query name: asset_tag__isw required: false schema: type: string - description: "" in: query name: asset_tag__nisw required: false schema: type: string - description: "" in: query name: asset_tag__ie required: false schema: type: string - description: "" in: query name: asset_tag__nie required: false schema: type: string - description: "" in: query name: asset_tag__empty required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: parent_id__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: "" in: query name: role_id__n required: false schema: type: string - description: "" in: query name: role__n required: false schema: type: string - description: "" in: query name: component_type__n required: false schema: type: string - description: "" in: query name: component_id__n required: false schema: type: string - description: "" in: query name: component_id__lte required: false schema: type: string - description: "" in: query name: component_id__lt required: false schema: type: string - description: "" in: query name: component_id__gte required: false schema: type: string - description: "" in: query name: component_id__gt required: false schema: type: string - description: "" in: query name: serial__n required: false schema: type: string - description: "" in: query name: serial__ic required: false schema: type: string - description: "" in: query name: serial__nic required: false schema: type: string - description: "" in: query name: serial__iew required: false schema: type: string - description: "" in: query name: serial__niew required: false schema: type: string - description: "" in: query name: serial__isw required: false schema: type: string - description: "" in: query name: serial__nisw required: false schema: type: string - description: "" in: query name: serial__ie required: false schema: type: string - description: "" in: query name: serial__nie required: false schema: type: string - description: "" in: query name: serial__empty required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/InventoryItem" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_inventory-items_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItem" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItem" description: "" tags: - dcim post: description: "" operationId: dcim_inventory-items_create requestBody: $ref: "#/components/requestBodies/WritableInventoryItem" responses: "201": content: application/json: schema: $ref: "#/components/schemas/InventoryItem" description: "" tags: - dcim put: description: "" operationId: dcim_inventory-items_bulk_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItem" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItem" description: "" tags: - dcim "/dcim/inventory-items/{id}/": delete: description: "" operationId: dcim_inventory-items_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_inventory-items_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItem" description: "" tags: - dcim parameters: - description: A unique integer value identifying this inventory item. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_inventory-items_partial_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItem" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItem" description: "" tags: - dcim put: description: "" operationId: dcim_inventory-items_update requestBody: $ref: "#/components/requestBodies/WritableInventoryItem" responses: "200": content: application/json: schema: $ref: "#/components/schemas/InventoryItem" description: "" tags: - dcim /dcim/locations/: delete: description: "" operationId: dcim_locations_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_locations_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: parent_id required: false schema: type: string - description: "" in: query name: parent required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: parent_id__n required: false schema: type: string - description: "" in: query name: parent__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Location" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_locations_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableLocation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Location" description: "" tags: - dcim post: description: "" operationId: dcim_locations_create requestBody: $ref: "#/components/requestBodies/WritableLocation" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Location" description: "" tags: - dcim put: description: "" operationId: dcim_locations_bulk_update requestBody: $ref: "#/components/requestBodies/WritableLocation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Location" description: "" tags: - dcim "/dcim/locations/{id}/": delete: description: "" operationId: dcim_locations_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_locations_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Location" description: "" tags: - dcim parameters: - description: A unique integer value identifying this location. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_locations_partial_update requestBody: $ref: "#/components/requestBodies/WritableLocation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Location" description: "" tags: - dcim put: description: "" operationId: dcim_locations_update requestBody: $ref: "#/components/requestBodies/WritableLocation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Location" description: "" tags: - dcim /dcim/manufacturers/: delete: description: "" operationId: dcim_manufacturers_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_manufacturers_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Manufacturer" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_manufacturers_bulk_partial_update requestBody: $ref: "#/components/requestBodies/Manufacturer" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Manufacturer" description: "" tags: - dcim post: description: "" operationId: dcim_manufacturers_create requestBody: $ref: "#/components/requestBodies/Manufacturer" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Manufacturer" description: "" tags: - dcim put: description: "" operationId: dcim_manufacturers_bulk_update requestBody: $ref: "#/components/requestBodies/Manufacturer" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Manufacturer" description: "" tags: - dcim "/dcim/manufacturers/{id}/": delete: description: "" operationId: dcim_manufacturers_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_manufacturers_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Manufacturer" description: "" tags: - dcim parameters: - description: A unique integer value identifying this manufacturer. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_manufacturers_partial_update requestBody: $ref: "#/components/requestBodies/Manufacturer" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Manufacturer" description: "" tags: - dcim put: description: "" operationId: dcim_manufacturers_update requestBody: $ref: "#/components/requestBodies/Manufacturer" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Manufacturer" description: "" tags: - dcim /dcim/module-bay-templates/: delete: description: "" operationId: dcim_module-bay-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_module-bay-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ModuleBayTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_module-bay-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableModuleBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBayTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_module-bay-templates_create requestBody: $ref: "#/components/requestBodies/WritableModuleBayTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ModuleBayTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_module-bay-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableModuleBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBayTemplate" description: "" tags: - dcim "/dcim/module-bay-templates/{id}/": delete: description: "" operationId: dcim_module-bay-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_module-bay-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBayTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this module bay template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_module-bay-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableModuleBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBayTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_module-bay-templates_update requestBody: $ref: "#/components/requestBodies/WritableModuleBayTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBayTemplate" description: "" tags: - dcim /dcim/module-bays/: delete: description: "" operationId: dcim_module-bays_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_module-bays_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ModuleBay" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_module-bays_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableModuleBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBay" description: "" tags: - dcim post: description: "" operationId: dcim_module-bays_create requestBody: $ref: "#/components/requestBodies/WritableModuleBay" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ModuleBay" description: "" tags: - dcim put: description: "" operationId: dcim_module-bays_bulk_update requestBody: $ref: "#/components/requestBodies/WritableModuleBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBay" description: "" tags: - dcim "/dcim/module-bays/{id}/": delete: description: "" operationId: dcim_module-bays_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_module-bays_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBay" description: "" tags: - dcim parameters: - description: A unique integer value identifying this module bay. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_module-bays_partial_update requestBody: $ref: "#/components/requestBodies/WritableModuleBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBay" description: "" tags: - dcim put: description: "" operationId: dcim_module-bays_update requestBody: $ref: "#/components/requestBodies/WritableModuleBay" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleBay" description: "" tags: - dcim /dcim/module-types/: delete: description: "" operationId: dcim_module-types_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_module-types_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: model required: false schema: type: string - description: "" in: query name: part_number required: false schema: type: string - description: "" in: query name: weight required: false schema: type: string - description: "" in: query name: weight_unit required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: console_ports required: false schema: type: string - description: "" in: query name: console_server_ports required: false schema: type: string - description: "" in: query name: power_ports required: false schema: type: string - description: "" in: query name: power_outlets required: false schema: type: string - description: "" in: query name: interfaces required: false schema: type: string - description: "" in: query name: pass_through_ports required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: model__n required: false schema: type: string - description: "" in: query name: model__ic required: false schema: type: string - description: "" in: query name: model__nic required: false schema: type: string - description: "" in: query name: model__iew required: false schema: type: string - description: "" in: query name: model__niew required: false schema: type: string - description: "" in: query name: model__isw required: false schema: type: string - description: "" in: query name: model__nisw required: false schema: type: string - description: "" in: query name: model__ie required: false schema: type: string - description: "" in: query name: model__nie required: false schema: type: string - description: "" in: query name: model__empty required: false schema: type: string - description: "" in: query name: part_number__n required: false schema: type: string - description: "" in: query name: part_number__ic required: false schema: type: string - description: "" in: query name: part_number__nic required: false schema: type: string - description: "" in: query name: part_number__iew required: false schema: type: string - description: "" in: query name: part_number__niew required: false schema: type: string - description: "" in: query name: part_number__isw required: false schema: type: string - description: "" in: query name: part_number__nisw required: false schema: type: string - description: "" in: query name: part_number__ie required: false schema: type: string - description: "" in: query name: part_number__nie required: false schema: type: string - description: "" in: query name: part_number__empty required: false schema: type: string - description: "" in: query name: weight__n required: false schema: type: string - description: "" in: query name: weight__lte required: false schema: type: string - description: "" in: query name: weight__lt required: false schema: type: string - description: "" in: query name: weight__gte required: false schema: type: string - description: "" in: query name: weight__gt required: false schema: type: string - description: "" in: query name: weight_unit__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ModuleType" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_module-types_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableModuleType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleType" description: "" tags: - dcim post: description: "" operationId: dcim_module-types_create requestBody: $ref: "#/components/requestBodies/WritableModuleType" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ModuleType" description: "" tags: - dcim put: description: "" operationId: dcim_module-types_bulk_update requestBody: $ref: "#/components/requestBodies/WritableModuleType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleType" description: "" tags: - dcim "/dcim/module-types/{id}/": delete: description: "" operationId: dcim_module-types_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_module-types_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleType" description: "" tags: - dcim parameters: - description: A unique integer value identifying this module type. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_module-types_partial_update requestBody: $ref: "#/components/requestBodies/WritableModuleType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleType" description: "" tags: - dcim put: description: "" operationId: dcim_module-types_update requestBody: $ref: "#/components/requestBodies/WritableModuleType" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ModuleType" description: "" tags: - dcim /dcim/modules/: delete: description: "" operationId: dcim_modules_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_modules_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: asset_tag required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: module_type_id required: false schema: type: string - description: "" in: query name: module_type required: false schema: type: string - description: "" in: query name: module_bay_id required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: serial required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: asset_tag__n required: false schema: type: string - description: "" in: query name: asset_tag__ic required: false schema: type: string - description: "" in: query name: asset_tag__nic required: false schema: type: string - description: "" in: query name: asset_tag__iew required: false schema: type: string - description: "" in: query name: asset_tag__niew required: false schema: type: string - description: "" in: query name: asset_tag__isw required: false schema: type: string - description: "" in: query name: asset_tag__nisw required: false schema: type: string - description: "" in: query name: asset_tag__ie required: false schema: type: string - description: "" in: query name: asset_tag__nie required: false schema: type: string - description: "" in: query name: asset_tag__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: "" in: query name: module_type_id__n required: false schema: type: string - description: "" in: query name: module_type__n required: false schema: type: string - description: "" in: query name: module_bay_id__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: serial__n required: false schema: type: string - description: "" in: query name: serial__ic required: false schema: type: string - description: "" in: query name: serial__nic required: false schema: type: string - description: "" in: query name: serial__iew required: false schema: type: string - description: "" in: query name: serial__niew required: false schema: type: string - description: "" in: query name: serial__isw required: false schema: type: string - description: "" in: query name: serial__nisw required: false schema: type: string - description: "" in: query name: serial__ie required: false schema: type: string - description: "" in: query name: serial__nie required: false schema: type: string - description: "" in: query name: serial__empty required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Module" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_modules_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableModule" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Module" description: "" tags: - dcim post: description: "" operationId: dcim_modules_create requestBody: $ref: "#/components/requestBodies/WritableModule" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Module" description: "" tags: - dcim put: description: "" operationId: dcim_modules_bulk_update requestBody: $ref: "#/components/requestBodies/WritableModule" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Module" description: "" tags: - dcim "/dcim/modules/{id}/": delete: description: "" operationId: dcim_modules_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_modules_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Module" description: "" tags: - dcim parameters: - description: A unique integer value identifying this module. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_modules_partial_update requestBody: $ref: "#/components/requestBodies/WritableModule" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Module" description: "" tags: - dcim put: description: "" operationId: dcim_modules_update requestBody: $ref: "#/components/requestBodies/WritableModule" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Module" description: "" tags: - dcim /dcim/platforms/: delete: description: "" operationId: dcim_platforms_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_platforms_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: napalm_driver required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: manufacturer_id required: false schema: type: string - description: "" in: query name: manufacturer required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: napalm_driver__n required: false schema: type: string - description: "" in: query name: napalm_driver__ic required: false schema: type: string - description: "" in: query name: napalm_driver__nic required: false schema: type: string - description: "" in: query name: napalm_driver__iew required: false schema: type: string - description: "" in: query name: napalm_driver__niew required: false schema: type: string - description: "" in: query name: napalm_driver__isw required: false schema: type: string - description: "" in: query name: napalm_driver__nisw required: false schema: type: string - description: "" in: query name: napalm_driver__ie required: false schema: type: string - description: "" in: query name: napalm_driver__nie required: false schema: type: string - description: "" in: query name: napalm_driver__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: manufacturer_id__n required: false schema: type: string - description: "" in: query name: manufacturer__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Platform" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_platforms_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePlatform" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Platform" description: "" tags: - dcim post: description: "" operationId: dcim_platforms_create requestBody: $ref: "#/components/requestBodies/WritablePlatform" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Platform" description: "" tags: - dcim put: description: "" operationId: dcim_platforms_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePlatform" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Platform" description: "" tags: - dcim "/dcim/platforms/{id}/": delete: description: "" operationId: dcim_platforms_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_platforms_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Platform" description: "" tags: - dcim parameters: - description: A unique integer value identifying this platform. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_platforms_partial_update requestBody: $ref: "#/components/requestBodies/WritablePlatform" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Platform" description: "" tags: - dcim put: description: "" operationId: dcim_platforms_update requestBody: $ref: "#/components/requestBodies/WritablePlatform" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Platform" description: "" tags: - dcim /dcim/power-feeds/: delete: description: "" operationId: dcim_power-feeds_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-feeds_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: supply required: false schema: type: string - description: "" in: query name: phase required: false schema: type: string - description: "" in: query name: voltage required: false schema: type: string - description: "" in: query name: amperage required: false schema: type: string - description: "" in: query name: max_utilization required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: connected required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: power_panel_id required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: supply__n required: false schema: type: string - description: "" in: query name: phase__n required: false schema: type: string - description: "" in: query name: voltage__n required: false schema: type: string - description: "" in: query name: voltage__lte required: false schema: type: string - description: "" in: query name: voltage__lt required: false schema: type: string - description: "" in: query name: voltage__gte required: false schema: type: string - description: "" in: query name: voltage__gt required: false schema: type: string - description: "" in: query name: amperage__n required: false schema: type: string - description: "" in: query name: amperage__lte required: false schema: type: string - description: "" in: query name: amperage__lt required: false schema: type: string - description: "" in: query name: amperage__gte required: false schema: type: string - description: "" in: query name: amperage__gt required: false schema: type: string - description: "" in: query name: max_utilization__n required: false schema: type: string - description: "" in: query name: max_utilization__lte required: false schema: type: string - description: "" in: query name: max_utilization__lt required: false schema: type: string - description: "" in: query name: max_utilization__gte required: false schema: type: string - description: "" in: query name: max_utilization__gt required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: power_panel_id__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/PowerFeed" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_power-feeds_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerFeed" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim post: description: "" operationId: dcim_power-feeds_create requestBody: $ref: "#/components/requestBodies/WritablePowerFeed" responses: "201": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim put: description: "" operationId: dcim_power-feeds_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePowerFeed" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim "/dcim/power-feeds/{id}/": delete: description: "" operationId: dcim_power-feeds_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-feeds_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power feed. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_power-feeds_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerFeed" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim put: description: "" operationId: dcim_power-feeds_update requestBody: $ref: "#/components/requestBodies/WritablePowerFeed" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim "/dcim/power-feeds/{id}/trace/": get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_power-feeds_trace responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerFeed" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power feed. in: path name: id required: true schema: type: integer /dcim/power-outlet-templates/: delete: description: "" operationId: dcim_power-outlet-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-outlet-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: feed_leg required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: feed_leg__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/PowerOutletTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_power-outlet-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutletTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutletTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_power-outlet-templates_create requestBody: $ref: "#/components/requestBodies/WritablePowerOutletTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/PowerOutletTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_power-outlet-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutletTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutletTemplate" description: "" tags: - dcim "/dcim/power-outlet-templates/{id}/": delete: description: "" operationId: dcim_power-outlet-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-outlet-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutletTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power outlet template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_power-outlet-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutletTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutletTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_power-outlet-templates_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutletTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutletTemplate" description: "" tags: - dcim /dcim/power-outlets/: delete: description: "" operationId: dcim_power-outlets_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-outlets_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: feed_leg required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: connected required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: feed_leg__n required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/PowerOutlet" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_power-outlets_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutlet" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim post: description: "" operationId: dcim_power-outlets_create requestBody: $ref: "#/components/requestBodies/WritablePowerOutlet" responses: "201": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim put: description: "" operationId: dcim_power-outlets_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutlet" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim "/dcim/power-outlets/{id}/": delete: description: "" operationId: dcim_power-outlets_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-outlets_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power outlet. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_power-outlets_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutlet" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim put: description: "" operationId: dcim_power-outlets_update requestBody: $ref: "#/components/requestBodies/WritablePowerOutlet" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim "/dcim/power-outlets/{id}/trace/": get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_power-outlets_trace responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerOutlet" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power outlet. in: path name: id required: true schema: type: integer /dcim/power-panels/: delete: description: "" operationId: dcim_power-panels_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-panels_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/PowerPanel" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_power-panels_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerPanel" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPanel" description: "" tags: - dcim post: description: "" operationId: dcim_power-panels_create requestBody: $ref: "#/components/requestBodies/WritablePowerPanel" responses: "201": content: application/json: schema: $ref: "#/components/schemas/PowerPanel" description: "" tags: - dcim put: description: "" operationId: dcim_power-panels_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePowerPanel" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPanel" description: "" tags: - dcim "/dcim/power-panels/{id}/": delete: description: "" operationId: dcim_power-panels_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-panels_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPanel" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power panel. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_power-panels_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerPanel" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPanel" description: "" tags: - dcim put: description: "" operationId: dcim_power-panels_update requestBody: $ref: "#/components/requestBodies/WritablePowerPanel" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPanel" description: "" tags: - dcim /dcim/power-port-templates/: delete: description: "" operationId: dcim_power-port-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-port-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: maximum_draw required: false schema: type: string - description: "" in: query name: allocated_draw required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: maximum_draw__n required: false schema: type: string - description: "" in: query name: maximum_draw__lte required: false schema: type: string - description: "" in: query name: maximum_draw__lt required: false schema: type: string - description: "" in: query name: maximum_draw__gte required: false schema: type: string - description: "" in: query name: maximum_draw__gt required: false schema: type: string - description: "" in: query name: allocated_draw__n required: false schema: type: string - description: "" in: query name: allocated_draw__lte required: false schema: type: string - description: "" in: query name: allocated_draw__lt required: false schema: type: string - description: "" in: query name: allocated_draw__gte required: false schema: type: string - description: "" in: query name: allocated_draw__gt required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/PowerPortTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_power-port-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPortTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_power-port-templates_create requestBody: $ref: "#/components/requestBodies/WritablePowerPortTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/PowerPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_power-port-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePowerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPortTemplate" description: "" tags: - dcim "/dcim/power-port-templates/{id}/": delete: description: "" operationId: dcim_power-port-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-port-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPortTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power port template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_power-port-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_power-port-templates_update requestBody: $ref: "#/components/requestBodies/WritablePowerPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPortTemplate" description: "" tags: - dcim /dcim/power-ports/: delete: description: "" operationId: dcim_power-ports_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-ports_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: maximum_draw required: false schema: type: string - description: "" in: query name: allocated_draw required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: connected required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: maximum_draw__n required: false schema: type: string - description: "" in: query name: maximum_draw__lte required: false schema: type: string - description: "" in: query name: maximum_draw__lt required: false schema: type: string - description: "" in: query name: maximum_draw__gte required: false schema: type: string - description: "" in: query name: maximum_draw__gt required: false schema: type: string - description: "" in: query name: allocated_draw__n required: false schema: type: string - description: "" in: query name: allocated_draw__lte required: false schema: type: string - description: "" in: query name: allocated_draw__lt required: false schema: type: string - description: "" in: query name: allocated_draw__gte required: false schema: type: string - description: "" in: query name: allocated_draw__gt required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/PowerPort" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_power-ports_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim post: description: "" operationId: dcim_power-ports_create requestBody: $ref: "#/components/requestBodies/WritablePowerPort" responses: "201": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim put: description: "" operationId: dcim_power-ports_bulk_update requestBody: $ref: "#/components/requestBodies/WritablePowerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim "/dcim/power-ports/{id}/": delete: description: "" operationId: dcim_power-ports_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_power-ports_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power port. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_power-ports_partial_update requestBody: $ref: "#/components/requestBodies/WritablePowerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim put: description: "" operationId: dcim_power-ports_update requestBody: $ref: "#/components/requestBodies/WritablePowerPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim "/dcim/power-ports/{id}/trace/": get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_power-ports_trace responses: "200": content: application/json: schema: $ref: "#/components/schemas/PowerPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this power port. in: path name: id required: true schema: type: integer /dcim/rack-reservations/: delete: description: "" operationId: dcim_rack-reservations_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rack-reservations_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: user_id required: false schema: type: string - description: "" in: query name: user required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: user_id__n required: false schema: type: string - description: "" in: query name: user__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/RackReservation" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_rack-reservations_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableRackReservation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackReservation" description: "" tags: - dcim post: description: "" operationId: dcim_rack-reservations_create requestBody: $ref: "#/components/requestBodies/WritableRackReservation" responses: "201": content: application/json: schema: $ref: "#/components/schemas/RackReservation" description: "" tags: - dcim put: description: "" operationId: dcim_rack-reservations_bulk_update requestBody: $ref: "#/components/requestBodies/WritableRackReservation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackReservation" description: "" tags: - dcim "/dcim/rack-reservations/{id}/": delete: description: "" operationId: dcim_rack-reservations_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rack-reservations_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackReservation" description: "" tags: - dcim parameters: - description: A unique integer value identifying this rack reservation. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_rack-reservations_partial_update requestBody: $ref: "#/components/requestBodies/WritableRackReservation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackReservation" description: "" tags: - dcim put: description: "" operationId: dcim_rack-reservations_update requestBody: $ref: "#/components/requestBodies/WritableRackReservation" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackReservation" description: "" tags: - dcim /dcim/rack-roles/: delete: description: "" operationId: dcim_rack-roles_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rack-roles_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/RackRole" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_rack-roles_bulk_partial_update requestBody: $ref: "#/components/requestBodies/RackRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackRole" description: "" tags: - dcim post: description: "" operationId: dcim_rack-roles_create requestBody: $ref: "#/components/requestBodies/RackRole" responses: "201": content: application/json: schema: $ref: "#/components/schemas/RackRole" description: "" tags: - dcim put: description: "" operationId: dcim_rack-roles_bulk_update requestBody: $ref: "#/components/requestBodies/RackRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackRole" description: "" tags: - dcim "/dcim/rack-roles/{id}/": delete: description: "" operationId: dcim_rack-roles_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rack-roles_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackRole" description: "" tags: - dcim parameters: - description: A unique integer value identifying this rack role. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_rack-roles_partial_update requestBody: $ref: "#/components/requestBodies/RackRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackRole" description: "" tags: - dcim put: description: "" operationId: dcim_rack-roles_update requestBody: $ref: "#/components/requestBodies/RackRole" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RackRole" description: "" tags: - dcim /dcim/racks/: delete: description: "" operationId: dcim_racks_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_racks_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: facility_id required: false schema: type: string - description: "" in: query name: asset_tag required: false schema: type: string - description: "" in: query name: u_height required: false schema: type: string - description: "" in: query name: desc_units required: false schema: type: string - description: "" in: query name: outer_width required: false schema: type: string - description: "" in: query name: outer_depth required: false schema: type: string - description: "" in: query name: outer_unit required: false schema: type: string - description: "" in: query name: mounting_depth required: false schema: type: string - description: "" in: query name: weight required: false schema: type: string - description: "" in: query name: max_weight required: false schema: type: string - description: "" in: query name: weight_unit required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: width required: false schema: type: string - description: "" in: query name: role_id required: false schema: type: string - description: "" in: query name: role required: false schema: type: string - description: "" in: query name: serial required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: facility_id__n required: false schema: type: string - description: "" in: query name: facility_id__ic required: false schema: type: string - description: "" in: query name: facility_id__nic required: false schema: type: string - description: "" in: query name: facility_id__iew required: false schema: type: string - description: "" in: query name: facility_id__niew required: false schema: type: string - description: "" in: query name: facility_id__isw required: false schema: type: string - description: "" in: query name: facility_id__nisw required: false schema: type: string - description: "" in: query name: facility_id__ie required: false schema: type: string - description: "" in: query name: facility_id__nie required: false schema: type: string - description: "" in: query name: facility_id__empty required: false schema: type: string - description: "" in: query name: asset_tag__n required: false schema: type: string - description: "" in: query name: asset_tag__ic required: false schema: type: string - description: "" in: query name: asset_tag__nic required: false schema: type: string - description: "" in: query name: asset_tag__iew required: false schema: type: string - description: "" in: query name: asset_tag__niew required: false schema: type: string - description: "" in: query name: asset_tag__isw required: false schema: type: string - description: "" in: query name: asset_tag__nisw required: false schema: type: string - description: "" in: query name: asset_tag__ie required: false schema: type: string - description: "" in: query name: asset_tag__nie required: false schema: type: string - description: "" in: query name: asset_tag__empty required: false schema: type: string - description: "" in: query name: u_height__n required: false schema: type: string - description: "" in: query name: u_height__lte required: false schema: type: string - description: "" in: query name: u_height__lt required: false schema: type: string - description: "" in: query name: u_height__gte required: false schema: type: string - description: "" in: query name: u_height__gt required: false schema: type: string - description: "" in: query name: outer_width__n required: false schema: type: string - description: "" in: query name: outer_width__lte required: false schema: type: string - description: "" in: query name: outer_width__lt required: false schema: type: string - description: "" in: query name: outer_width__gte required: false schema: type: string - description: "" in: query name: outer_width__gt required: false schema: type: string - description: "" in: query name: outer_depth__n required: false schema: type: string - description: "" in: query name: outer_depth__lte required: false schema: type: string - description: "" in: query name: outer_depth__lt required: false schema: type: string - description: "" in: query name: outer_depth__gte required: false schema: type: string - description: "" in: query name: outer_depth__gt required: false schema: type: string - description: "" in: query name: outer_unit__n required: false schema: type: string - description: "" in: query name: mounting_depth__n required: false schema: type: string - description: "" in: query name: mounting_depth__lte required: false schema: type: string - description: "" in: query name: mounting_depth__lt required: false schema: type: string - description: "" in: query name: mounting_depth__gte required: false schema: type: string - description: "" in: query name: mounting_depth__gt required: false schema: type: string - description: "" in: query name: weight__n required: false schema: type: string - description: "" in: query name: weight__lte required: false schema: type: string - description: "" in: query name: weight__lt required: false schema: type: string - description: "" in: query name: weight__gte required: false schema: type: string - description: "" in: query name: weight__gt required: false schema: type: string - description: "" in: query name: max_weight__n required: false schema: type: string - description: "" in: query name: max_weight__lte required: false schema: type: string - description: "" in: query name: max_weight__lt required: false schema: type: string - description: "" in: query name: max_weight__gte required: false schema: type: string - description: "" in: query name: max_weight__gt required: false schema: type: string - description: "" in: query name: weight_unit__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: width__n required: false schema: type: string - description: "" in: query name: role_id__n required: false schema: type: string - description: "" in: query name: role__n required: false schema: type: string - description: "" in: query name: serial__n required: false schema: type: string - description: "" in: query name: serial__ic required: false schema: type: string - description: "" in: query name: serial__nic required: false schema: type: string - description: "" in: query name: serial__iew required: false schema: type: string - description: "" in: query name: serial__niew required: false schema: type: string - description: "" in: query name: serial__isw required: false schema: type: string - description: "" in: query name: serial__nisw required: false schema: type: string - description: "" in: query name: serial__ie required: false schema: type: string - description: "" in: query name: serial__nie required: false schema: type: string - description: "" in: query name: serial__empty required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Rack" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_racks_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableRack" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Rack" description: "" tags: - dcim post: description: "" operationId: dcim_racks_create requestBody: $ref: "#/components/requestBodies/WritableRack" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Rack" description: "" tags: - dcim put: description: "" operationId: dcim_racks_bulk_update requestBody: $ref: "#/components/requestBodies/WritableRack" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Rack" description: "" tags: - dcim "/dcim/racks/{id}/": delete: description: "" operationId: dcim_racks_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_racks_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Rack" description: "" tags: - dcim parameters: - description: A unique integer value identifying this rack. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_racks_partial_update requestBody: $ref: "#/components/requestBodies/WritableRack" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Rack" description: "" tags: - dcim put: description: "" operationId: dcim_racks_update requestBody: $ref: "#/components/requestBodies/WritableRack" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Rack" description: "" tags: - dcim "/dcim/racks/{id}/elevation/": get: description: Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG. operationId: dcim_racks_elevation parameters: - in: query name: q required: false schema: minLength: 1 type: string - in: query name: face required: false schema: default: front enum: - front - rear type: string - in: query name: render required: false schema: default: json enum: - json - svg type: string - in: query name: unit_width required: false schema: default: 220 type: integer - in: query name: unit_height required: false schema: default: 22 type: integer - in: query name: legend_width required: false schema: default: 30 type: integer - in: query name: margin_width required: false schema: default: 15 type: integer - in: query name: exclude required: false schema: type: integer - in: query name: expand_devices required: false schema: default: true type: boolean - in: query name: include_images required: false schema: default: true type: boolean responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/RackUnit" type: array description: "" tags: - dcim parameters: - description: A unique integer value identifying this rack. in: path name: id required: true schema: type: integer /dcim/rear-port-templates/: delete: description: "" operationId: dcim_rear-port-templates_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rear-port-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: positions required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: devicetype_id required: false schema: type: string - description: "" in: query name: moduletype_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: positions__n required: false schema: type: string - description: "" in: query name: positions__lte required: false schema: type: string - description: "" in: query name: positions__lt required: false schema: type: string - description: "" in: query name: positions__gte required: false schema: type: string - description: "" in: query name: positions__gt required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: devicetype_id__n required: false schema: type: string - description: "" in: query name: moduletype_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/RearPortTemplate" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_rear-port-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableRearPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPortTemplate" description: "" tags: - dcim post: description: "" operationId: dcim_rear-port-templates_create requestBody: $ref: "#/components/requestBodies/WritableRearPortTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/RearPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_rear-port-templates_bulk_update requestBody: $ref: "#/components/requestBodies/WritableRearPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPortTemplate" description: "" tags: - dcim "/dcim/rear-port-templates/{id}/": delete: description: "" operationId: dcim_rear-port-templates_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rear-port-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPortTemplate" description: "" tags: - dcim parameters: - description: A unique integer value identifying this rear port template. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_rear-port-templates_partial_update requestBody: $ref: "#/components/requestBodies/WritableRearPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPortTemplate" description: "" tags: - dcim put: description: "" operationId: dcim_rear-port-templates_update requestBody: $ref: "#/components/requestBodies/WritableRearPortTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPortTemplate" description: "" tags: - dcim /dcim/rear-ports/: delete: description: "" operationId: dcim_rear-ports_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rear-ports_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: label required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: color required: false schema: type: string - description: "" in: query name: positions required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: cable_end required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: rack_id required: false schema: type: string - description: "" in: query name: rack required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: virtual_chassis_id required: false schema: type: string - description: "" in: query name: virtual_chassis required: false schema: type: string - description: "" in: query name: module_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: cabled required: false schema: type: string - description: "" in: query name: occupied required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: label__n required: false schema: type: string - description: "" in: query name: label__ic required: false schema: type: string - description: "" in: query name: label__nic required: false schema: type: string - description: "" in: query name: label__iew required: false schema: type: string - description: "" in: query name: label__niew required: false schema: type: string - description: "" in: query name: label__isw required: false schema: type: string - description: "" in: query name: label__nisw required: false schema: type: string - description: "" in: query name: label__ie required: false schema: type: string - description: "" in: query name: label__nie required: false schema: type: string - description: "" in: query name: label__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: color__n required: false schema: type: string - description: "" in: query name: color__ic required: false schema: type: string - description: "" in: query name: color__nic required: false schema: type: string - description: "" in: query name: color__iew required: false schema: type: string - description: "" in: query name: color__niew required: false schema: type: string - description: "" in: query name: color__isw required: false schema: type: string - description: "" in: query name: color__nisw required: false schema: type: string - description: "" in: query name: color__ie required: false schema: type: string - description: "" in: query name: color__nie required: false schema: type: string - description: "" in: query name: color__empty required: false schema: type: string - description: "" in: query name: positions__n required: false schema: type: string - description: "" in: query name: positions__lte required: false schema: type: string - description: "" in: query name: positions__lt required: false schema: type: string - description: "" in: query name: positions__gte required: false schema: type: string - description: "" in: query name: positions__gt required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: cable_end__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: rack_id__n required: false schema: type: string - description: "" in: query name: rack__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: virtual_chassis_id__n required: false schema: type: string - description: "" in: query name: virtual_chassis__n required: false schema: type: string - description: "" in: query name: module_id__n required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/RearPort" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_rear-ports_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableRearPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim post: description: "" operationId: dcim_rear-ports_create requestBody: $ref: "#/components/requestBodies/WritableRearPort" responses: "201": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim put: description: "" operationId: dcim_rear-ports_bulk_update requestBody: $ref: "#/components/requestBodies/WritableRearPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim "/dcim/rear-ports/{id}/": delete: description: "" operationId: dcim_rear-ports_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_rear-ports_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this rear port. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_rear-ports_partial_update requestBody: $ref: "#/components/requestBodies/WritableRearPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim put: description: "" operationId: dcim_rear-ports_update requestBody: $ref: "#/components/requestBodies/WritableRearPort" responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim "/dcim/rear-ports/{id}/paths/": get: description: Return all CablePaths which traverse a given pass-through port. operationId: dcim_rear-ports_paths responses: "200": content: application/json: schema: $ref: "#/components/schemas/RearPort" description: "" tags: - dcim parameters: - description: A unique integer value identifying this rear port. in: path name: id required: true schema: type: integer /dcim/regions/: delete: description: "" operationId: dcim_regions_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_regions_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: parent_id required: false schema: type: string - description: "" in: query name: parent required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: parent_id__n required: false schema: type: string - description: "" in: query name: parent__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Region" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_regions_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableRegion" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Region" description: "" tags: - dcim post: description: "" operationId: dcim_regions_create requestBody: $ref: "#/components/requestBodies/WritableRegion" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Region" description: "" tags: - dcim put: description: "" operationId: dcim_regions_bulk_update requestBody: $ref: "#/components/requestBodies/WritableRegion" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Region" description: "" tags: - dcim "/dcim/regions/{id}/": delete: description: "" operationId: dcim_regions_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_regions_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Region" description: "" tags: - dcim parameters: - description: A unique integer value identifying this region. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_regions_partial_update requestBody: $ref: "#/components/requestBodies/WritableRegion" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Region" description: "" tags: - dcim put: description: "" operationId: dcim_regions_update requestBody: $ref: "#/components/requestBodies/WritableRegion" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Region" description: "" tags: - dcim /dcim/site-groups/: delete: description: "" operationId: dcim_site-groups_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_site-groups_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: parent_id required: false schema: type: string - description: "" in: query name: parent required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: parent_id__n required: false schema: type: string - description: "" in: query name: parent__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/SiteGroup" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_site-groups_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableSiteGroup" responses: "200": content: application/json: schema: $ref: "#/components/schemas/SiteGroup" description: "" tags: - dcim post: description: "" operationId: dcim_site-groups_create requestBody: $ref: "#/components/requestBodies/WritableSiteGroup" responses: "201": content: application/json: schema: $ref: "#/components/schemas/SiteGroup" description: "" tags: - dcim put: description: "" operationId: dcim_site-groups_bulk_update requestBody: $ref: "#/components/requestBodies/WritableSiteGroup" responses: "200": content: application/json: schema: $ref: "#/components/schemas/SiteGroup" description: "" tags: - dcim "/dcim/site-groups/{id}/": delete: description: "" operationId: dcim_site-groups_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_site-groups_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/SiteGroup" description: "" tags: - dcim parameters: - description: A unique integer value identifying this site group. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_site-groups_partial_update requestBody: $ref: "#/components/requestBodies/WritableSiteGroup" responses: "200": content: application/json: schema: $ref: "#/components/schemas/SiteGroup" description: "" tags: - dcim put: description: "" operationId: dcim_site-groups_update requestBody: $ref: "#/components/requestBodies/WritableSiteGroup" responses: "200": content: application/json: schema: $ref: "#/components/schemas/SiteGroup" description: "" tags: - dcim /dcim/sites/: delete: description: "" operationId: dcim_sites_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_sites_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: slug required: false schema: type: string - description: "" in: query name: facility required: false schema: type: string - description: "" in: query name: latitude required: false schema: type: string - description: "" in: query name: longitude required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: contact required: false schema: type: string - description: "" in: query name: contact_role required: false schema: type: string - description: "" in: query name: contact_group required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: group_id required: false schema: type: string - description: "" in: query name: group required: false schema: type: string - description: "" in: query name: asn required: false schema: type: string - description: "" in: query name: asn_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: slug__n required: false schema: type: string - description: "" in: query name: slug__ic required: false schema: type: string - description: "" in: query name: slug__nic required: false schema: type: string - description: "" in: query name: slug__iew required: false schema: type: string - description: "" in: query name: slug__niew required: false schema: type: string - description: "" in: query name: slug__isw required: false schema: type: string - description: "" in: query name: slug__nisw required: false schema: type: string - description: "" in: query name: slug__ie required: false schema: type: string - description: "" in: query name: slug__nie required: false schema: type: string - description: "" in: query name: slug__empty required: false schema: type: string - description: "" in: query name: facility__n required: false schema: type: string - description: "" in: query name: facility__ic required: false schema: type: string - description: "" in: query name: facility__nic required: false schema: type: string - description: "" in: query name: facility__iew required: false schema: type: string - description: "" in: query name: facility__niew required: false schema: type: string - description: "" in: query name: facility__isw required: false schema: type: string - description: "" in: query name: facility__nisw required: false schema: type: string - description: "" in: query name: facility__ie required: false schema: type: string - description: "" in: query name: facility__nie required: false schema: type: string - description: "" in: query name: facility__empty required: false schema: type: string - description: "" in: query name: latitude__n required: false schema: type: string - description: "" in: query name: latitude__lte required: false schema: type: string - description: "" in: query name: latitude__lt required: false schema: type: string - description: "" in: query name: latitude__gte required: false schema: type: string - description: "" in: query name: latitude__gt required: false schema: type: string - description: "" in: query name: longitude__n required: false schema: type: string - description: "" in: query name: longitude__lte required: false schema: type: string - description: "" in: query name: longitude__lt required: false schema: type: string - description: "" in: query name: longitude__gte required: false schema: type: string - description: "" in: query name: longitude__gt required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: contact__n required: false schema: type: string - description: "" in: query name: contact_role__n required: false schema: type: string - description: "" in: query name: contact_group__n required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: group_id__n required: false schema: type: string - description: "" in: query name: group__n required: false schema: type: string - description: "" in: query name: asn__n required: false schema: type: string - description: "" in: query name: asn_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/Site" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_sites_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableSite" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Site" description: "" tags: - dcim post: description: "" operationId: dcim_sites_create requestBody: $ref: "#/components/requestBodies/WritableSite" responses: "201": content: application/json: schema: $ref: "#/components/schemas/Site" description: "" tags: - dcim put: description: "" operationId: dcim_sites_bulk_update requestBody: $ref: "#/components/requestBodies/WritableSite" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Site" description: "" tags: - dcim "/dcim/sites/{id}/": delete: description: "" operationId: dcim_sites_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_sites_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/Site" description: "" tags: - dcim parameters: - description: A unique integer value identifying this site. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_sites_partial_update requestBody: $ref: "#/components/requestBodies/WritableSite" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Site" description: "" tags: - dcim put: description: "" operationId: dcim_sites_update requestBody: $ref: "#/components/requestBodies/WritableSite" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Site" description: "" tags: - dcim /dcim/virtual-chassis/: delete: description: "" operationId: dcim_virtual-chassis_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_virtual-chassis_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: domain required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: master_id required: false schema: type: string - description: "" in: query name: master required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: domain__n required: false schema: type: string - description: "" in: query name: domain__ic required: false schema: type: string - description: "" in: query name: domain__nic required: false schema: type: string - description: "" in: query name: domain__iew required: false schema: type: string - description: "" in: query name: domain__niew required: false schema: type: string - description: "" in: query name: domain__isw required: false schema: type: string - description: "" in: query name: domain__nisw required: false schema: type: string - description: "" in: query name: domain__ie required: false schema: type: string - description: "" in: query name: domain__nie required: false schema: type: string - description: "" in: query name: domain__empty required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: master_id__n required: false schema: type: string - description: "" in: query name: master__n required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/VirtualChassis" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_virtual-chassis_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableVirtualChassis" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualChassis" description: "" tags: - dcim post: description: "" operationId: dcim_virtual-chassis_create requestBody: $ref: "#/components/requestBodies/WritableVirtualChassis" responses: "201": content: application/json: schema: $ref: "#/components/schemas/VirtualChassis" description: "" tags: - dcim put: description: "" operationId: dcim_virtual-chassis_bulk_update requestBody: $ref: "#/components/requestBodies/WritableVirtualChassis" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualChassis" description: "" tags: - dcim "/dcim/virtual-chassis/{id}/": delete: description: "" operationId: dcim_virtual-chassis_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_virtual-chassis_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualChassis" description: "" tags: - dcim parameters: - description: A unique integer value identifying this virtual chassis. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_virtual-chassis_partial_update requestBody: $ref: "#/components/requestBodies/WritableVirtualChassis" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualChassis" description: "" tags: - dcim put: description: "" operationId: dcim_virtual-chassis_update requestBody: $ref: "#/components/requestBodies/WritableVirtualChassis" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualChassis" description: "" tags: - dcim /dcim/virtual-device-contexts/: delete: description: "" operationId: dcim_virtual-device-contexts_bulk_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_virtual-device-contexts_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: device required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: device_id required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: has_primary_ip required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: device__n required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: device_id__n required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/VirtualDeviceContext" type: array required: - count - results type: object description: "" tags: - dcim parameters: [] patch: description: "" operationId: dcim_virtual-device-contexts_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableVirtualDeviceContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualDeviceContext" description: "" tags: - dcim post: description: "" operationId: dcim_virtual-device-contexts_create requestBody: $ref: "#/components/requestBodies/WritableVirtualDeviceContext" responses: "201": content: application/json: schema: $ref: "#/components/schemas/VirtualDeviceContext" description: "" tags: - dcim put: description: "" operationId: dcim_virtual-device-contexts_bulk_update requestBody: $ref: "#/components/requestBodies/WritableVirtualDeviceContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualDeviceContext" description: "" tags: - dcim "/dcim/virtual-device-contexts/{id}/": delete: description: "" operationId: dcim_virtual-device-contexts_delete responses: "204": description: "" tags: - dcim get: description: "" operationId: dcim_virtual-device-contexts_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualDeviceContext" description: "" tags: - dcim parameters: - description: A unique integer value identifying this virtual device context. in: path name: id required: true schema: type: integer patch: description: "" operationId: dcim_virtual-device-contexts_partial_update requestBody: $ref: "#/components/requestBodies/WritableVirtualDeviceContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualDeviceContext" description: "" tags: - dcim put: description: "" operationId: dcim_virtual-device-contexts_update requestBody: $ref: "#/components/requestBodies/WritableVirtualDeviceContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/VirtualDeviceContext" description: "" tags: - dcim /extras/config-contexts/: delete: description: "" operationId: extras_config-contexts_bulk_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_config-contexts_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: is_active required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: region_id required: false schema: type: string - description: "" in: query name: region required: false schema: type: string - description: "" in: query name: site_group required: false schema: type: string - description: "" in: query name: site_group_id required: false schema: type: string - description: "" in: query name: site_id required: false schema: type: string - description: "" in: query name: site required: false schema: type: string - description: "" in: query name: location_id required: false schema: type: string - description: "" in: query name: location required: false schema: type: string - description: "" in: query name: device_type_id required: false schema: type: string - description: "" in: query name: role_id required: false schema: type: string - description: "" in: query name: role required: false schema: type: string - description: "" in: query name: platform_id required: false schema: type: string - description: "" in: query name: platform required: false schema: type: string - description: "" in: query name: cluster_type_id required: false schema: type: string - description: "" in: query name: cluster_type required: false schema: type: string - description: "" in: query name: cluster_group_id required: false schema: type: string - description: "" in: query name: cluster_group required: false schema: type: string - description: "" in: query name: cluster_id required: false schema: type: string - description: "" in: query name: tenant_group_id required: false schema: type: string - description: "" in: query name: tenant_group required: false schema: type: string - description: "" in: query name: tenant_id required: false schema: type: string - description: "" in: query name: tenant required: false schema: type: string - description: "" in: query name: tag_id required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: created__n required: false schema: type: string - description: "" in: query name: created__lte required: false schema: type: string - description: "" in: query name: created__lt required: false schema: type: string - description: "" in: query name: created__gte required: false schema: type: string - description: "" in: query name: created__gt required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: region_id__n required: false schema: type: string - description: "" in: query name: region__n required: false schema: type: string - description: "" in: query name: site_group__n required: false schema: type: string - description: "" in: query name: site_group_id__n required: false schema: type: string - description: "" in: query name: site_id__n required: false schema: type: string - description: "" in: query name: site__n required: false schema: type: string - description: "" in: query name: location_id__n required: false schema: type: string - description: "" in: query name: location__n required: false schema: type: string - description: "" in: query name: device_type_id__n required: false schema: type: string - description: "" in: query name: role_id__n required: false schema: type: string - description: "" in: query name: role__n required: false schema: type: string - description: "" in: query name: platform_id__n required: false schema: type: string - description: "" in: query name: platform__n required: false schema: type: string - description: "" in: query name: cluster_type_id__n required: false schema: type: string - description: "" in: query name: cluster_type__n required: false schema: type: string - description: "" in: query name: cluster_group_id__n required: false schema: type: string - description: "" in: query name: cluster_group__n required: false schema: type: string - description: "" in: query name: cluster_id__n required: false schema: type: string - description: "" in: query name: tenant_group_id__n required: false schema: type: string - description: "" in: query name: tenant_group__n required: false schema: type: string - description: "" in: query name: tenant_id__n required: false schema: type: string - description: "" in: query name: tenant__n required: false schema: type: string - description: "" in: query name: tag_id__n required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ConfigContext" type: array required: - count - results type: object description: "" tags: - extras parameters: [] patch: description: "" operationId: extras_config-contexts_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConfigContext" description: "" tags: - extras post: description: "" operationId: extras_config-contexts_create requestBody: $ref: "#/components/requestBodies/WritableConfigContext" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ConfigContext" description: "" tags: - extras put: description: "" operationId: extras_config-contexts_bulk_update requestBody: $ref: "#/components/requestBodies/WritableConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConfigContext" description: "" tags: - extras "/extras/config-contexts/{id}/": delete: description: "" operationId: extras_config-contexts_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_config-contexts_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConfigContext" description: "" tags: - extras parameters: - description: A unique integer value identifying this config context. in: path name: id required: true schema: type: integer patch: description: "" operationId: extras_config-contexts_partial_update requestBody: $ref: "#/components/requestBodies/WritableConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConfigContext" description: "" tags: - extras put: description: "" operationId: extras_config-contexts_update requestBody: $ref: "#/components/requestBodies/WritableConfigContext" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ConfigContext" description: "" tags: - extras /extras/content-types/: get: description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects. operationId: extras_content-types_list parameters: - description: "" in: query name: id required: false schema: type: number - description: "" in: query name: app_label required: false schema: type: string - description: "" in: query name: model required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ContentType" type: array required: - count - results type: object description: "" tags: - extras parameters: [] "/extras/content-types/{id}/": get: description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects. operationId: extras_content-types_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ContentType" description: "" tags: - extras parameters: - description: A unique integer value identifying this content type. in: path name: id required: true schema: type: integer /extras/custom-fields/: delete: description: "" operationId: extras_custom-fields_bulk_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_custom-fields_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: content_types required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: group_name required: false schema: type: string - description: "" in: query name: required required: false schema: type: string - description: "" in: query name: search_weight required: false schema: type: string - description: "" in: query name: filter_logic required: false schema: type: string - description: "" in: query name: ui_visibility required: false schema: type: string - description: "" in: query name: weight required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: type required: false schema: type: string - description: "" in: query name: content_type_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: content_types__n required: false schema: type: string - description: "" in: query name: content_types__ic required: false schema: type: string - description: "" in: query name: content_types__nic required: false schema: type: string - description: "" in: query name: content_types__iew required: false schema: type: string - description: "" in: query name: content_types__niew required: false schema: type: string - description: "" in: query name: content_types__isw required: false schema: type: string - description: "" in: query name: content_types__nisw required: false schema: type: string - description: "" in: query name: content_types__ie required: false schema: type: string - description: "" in: query name: content_types__nie required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: group_name__n required: false schema: type: string - description: "" in: query name: group_name__ic required: false schema: type: string - description: "" in: query name: group_name__nic required: false schema: type: string - description: "" in: query name: group_name__iew required: false schema: type: string - description: "" in: query name: group_name__niew required: false schema: type: string - description: "" in: query name: group_name__isw required: false schema: type: string - description: "" in: query name: group_name__nisw required: false schema: type: string - description: "" in: query name: group_name__ie required: false schema: type: string - description: "" in: query name: group_name__nie required: false schema: type: string - description: "" in: query name: group_name__empty required: false schema: type: string - description: "" in: query name: search_weight__n required: false schema: type: string - description: "" in: query name: search_weight__lte required: false schema: type: string - description: "" in: query name: search_weight__lt required: false schema: type: string - description: "" in: query name: search_weight__gte required: false schema: type: string - description: "" in: query name: search_weight__gt required: false schema: type: string - description: "" in: query name: filter_logic__n required: false schema: type: string - description: "" in: query name: ui_visibility__n required: false schema: type: string - description: "" in: query name: weight__n required: false schema: type: string - description: "" in: query name: weight__lte required: false schema: type: string - description: "" in: query name: weight__lt required: false schema: type: string - description: "" in: query name: weight__gte required: false schema: type: string - description: "" in: query name: weight__gt required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: type__n required: false schema: type: string - description: "" in: query name: content_type_id__n required: false schema: type: string - description: "" in: query name: content_type_id__lte required: false schema: type: string - description: "" in: query name: content_type_id__lt required: false schema: type: string - description: "" in: query name: content_type_id__gte required: false schema: type: string - description: "" in: query name: content_type_id__gt required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/CustomField" type: array required: - count - results type: object description: "" tags: - extras parameters: [] patch: description: "" operationId: extras_custom-fields_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableCustomField" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomField" description: "" tags: - extras post: description: "" operationId: extras_custom-fields_create requestBody: $ref: "#/components/requestBodies/WritableCustomField" responses: "201": content: application/json: schema: $ref: "#/components/schemas/CustomField" description: "" tags: - extras put: description: "" operationId: extras_custom-fields_bulk_update requestBody: $ref: "#/components/requestBodies/WritableCustomField" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomField" description: "" tags: - extras "/extras/custom-fields/{id}/": delete: description: "" operationId: extras_custom-fields_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_custom-fields_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomField" description: "" tags: - extras parameters: - description: A unique integer value identifying this custom field. in: path name: id required: true schema: type: integer patch: description: "" operationId: extras_custom-fields_partial_update requestBody: $ref: "#/components/requestBodies/WritableCustomField" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomField" description: "" tags: - extras put: description: "" operationId: extras_custom-fields_update requestBody: $ref: "#/components/requestBodies/WritableCustomField" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomField" description: "" tags: - extras /extras/custom-links/: delete: description: "" operationId: extras_custom-links_bulk_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_custom-links_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: content_types required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: enabled required: false schema: type: string - description: "" in: query name: link_text required: false schema: type: string - description: "" in: query name: link_url required: false schema: type: string - description: "" in: query name: weight required: false schema: type: string - description: "" in: query name: group_name required: false schema: type: string - description: "" in: query name: new_window required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: content_type_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: content_types__n required: false schema: type: string - description: "" in: query name: content_types__ic required: false schema: type: string - description: "" in: query name: content_types__nic required: false schema: type: string - description: "" in: query name: content_types__iew required: false schema: type: string - description: "" in: query name: content_types__niew required: false schema: type: string - description: "" in: query name: content_types__isw required: false schema: type: string - description: "" in: query name: content_types__nisw required: false schema: type: string - description: "" in: query name: content_types__ie required: false schema: type: string - description: "" in: query name: content_types__nie required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: link_text__n required: false schema: type: string - description: "" in: query name: link_text__ic required: false schema: type: string - description: "" in: query name: link_text__nic required: false schema: type: string - description: "" in: query name: link_text__iew required: false schema: type: string - description: "" in: query name: link_text__niew required: false schema: type: string - description: "" in: query name: link_text__isw required: false schema: type: string - description: "" in: query name: link_text__nisw required: false schema: type: string - description: "" in: query name: link_text__ie required: false schema: type: string - description: "" in: query name: link_text__nie required: false schema: type: string - description: "" in: query name: link_url__n required: false schema: type: string - description: "" in: query name: link_url__ic required: false schema: type: string - description: "" in: query name: link_url__nic required: false schema: type: string - description: "" in: query name: link_url__iew required: false schema: type: string - description: "" in: query name: link_url__niew required: false schema: type: string - description: "" in: query name: link_url__isw required: false schema: type: string - description: "" in: query name: link_url__nisw required: false schema: type: string - description: "" in: query name: link_url__ie required: false schema: type: string - description: "" in: query name: link_url__nie required: false schema: type: string - description: "" in: query name: weight__n required: false schema: type: string - description: "" in: query name: weight__lte required: false schema: type: string - description: "" in: query name: weight__lt required: false schema: type: string - description: "" in: query name: weight__gte required: false schema: type: string - description: "" in: query name: weight__gt required: false schema: type: string - description: "" in: query name: group_name__n required: false schema: type: string - description: "" in: query name: group_name__ic required: false schema: type: string - description: "" in: query name: group_name__nic required: false schema: type: string - description: "" in: query name: group_name__iew required: false schema: type: string - description: "" in: query name: group_name__niew required: false schema: type: string - description: "" in: query name: group_name__isw required: false schema: type: string - description: "" in: query name: group_name__nisw required: false schema: type: string - description: "" in: query name: group_name__ie required: false schema: type: string - description: "" in: query name: group_name__nie required: false schema: type: string - description: "" in: query name: group_name__empty required: false schema: type: string - description: "" in: query name: content_type_id__n required: false schema: type: string - description: "" in: query name: content_type_id__lte required: false schema: type: string - description: "" in: query name: content_type_id__lt required: false schema: type: string - description: "" in: query name: content_type_id__gte required: false schema: type: string - description: "" in: query name: content_type_id__gt required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/CustomLink" type: array required: - count - results type: object description: "" tags: - extras parameters: [] patch: description: "" operationId: extras_custom-links_bulk_partial_update requestBody: $ref: "#/components/requestBodies/CustomLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomLink" description: "" tags: - extras post: description: "" operationId: extras_custom-links_create requestBody: $ref: "#/components/requestBodies/CustomLink" responses: "201": content: application/json: schema: $ref: "#/components/schemas/CustomLink" description: "" tags: - extras put: description: "" operationId: extras_custom-links_bulk_update requestBody: $ref: "#/components/requestBodies/CustomLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomLink" description: "" tags: - extras "/extras/custom-links/{id}/": delete: description: "" operationId: extras_custom-links_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_custom-links_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomLink" description: "" tags: - extras parameters: - description: A unique integer value identifying this custom link. in: path name: id required: true schema: type: integer patch: description: "" operationId: extras_custom-links_partial_update requestBody: $ref: "#/components/requestBodies/CustomLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomLink" description: "" tags: - extras put: description: "" operationId: extras_custom-links_update requestBody: $ref: "#/components/requestBodies/CustomLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/CustomLink" description: "" tags: - extras /extras/export-templates/: delete: description: "" operationId: extras_export-templates_bulk_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_export-templates_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: content_types required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: description required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: content_type_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: content_types__n required: false schema: type: string - description: "" in: query name: content_types__ic required: false schema: type: string - description: "" in: query name: content_types__nic required: false schema: type: string - description: "" in: query name: content_types__iew required: false schema: type: string - description: "" in: query name: content_types__niew required: false schema: type: string - description: "" in: query name: content_types__isw required: false schema: type: string - description: "" in: query name: content_types__nisw required: false schema: type: string - description: "" in: query name: content_types__ie required: false schema: type: string - description: "" in: query name: content_types__nie required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: description__n required: false schema: type: string - description: "" in: query name: description__ic required: false schema: type: string - description: "" in: query name: description__nic required: false schema: type: string - description: "" in: query name: description__iew required: false schema: type: string - description: "" in: query name: description__niew required: false schema: type: string - description: "" in: query name: description__isw required: false schema: type: string - description: "" in: query name: description__nisw required: false schema: type: string - description: "" in: query name: description__ie required: false schema: type: string - description: "" in: query name: description__nie required: false schema: type: string - description: "" in: query name: description__empty required: false schema: type: string - description: "" in: query name: content_type_id__n required: false schema: type: string - description: "" in: query name: content_type_id__lte required: false schema: type: string - description: "" in: query name: content_type_id__lt required: false schema: type: string - description: "" in: query name: content_type_id__gte required: false schema: type: string - description: "" in: query name: content_type_id__gt required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ExportTemplate" type: array required: - count - results type: object description: "" tags: - extras parameters: [] patch: description: "" operationId: extras_export-templates_bulk_partial_update requestBody: $ref: "#/components/requestBodies/ExportTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExportTemplate" description: "" tags: - extras post: description: "" operationId: extras_export-templates_create requestBody: $ref: "#/components/requestBodies/ExportTemplate" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ExportTemplate" description: "" tags: - extras put: description: "" operationId: extras_export-templates_bulk_update requestBody: $ref: "#/components/requestBodies/ExportTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExportTemplate" description: "" tags: - extras "/extras/export-templates/{id}/": delete: description: "" operationId: extras_export-templates_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_export-templates_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExportTemplate" description: "" tags: - extras parameters: - description: A unique integer value identifying this export template. in: path name: id required: true schema: type: integer patch: description: "" operationId: extras_export-templates_partial_update requestBody: $ref: "#/components/requestBodies/ExportTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExportTemplate" description: "" tags: - extras put: description: "" operationId: extras_export-templates_update requestBody: $ref: "#/components/requestBodies/ExportTemplate" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ExportTemplate" description: "" tags: - extras /extras/image-attachments/: delete: description: "" operationId: extras_image-attachments_bulk_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_image-attachments_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: content_type_id required: false schema: type: string - description: "" in: query name: object_id required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: content_type required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: content_type_id__n required: false schema: type: string - description: "" in: query name: object_id__n required: false schema: type: string - description: "" in: query name: object_id__lte required: false schema: type: string - description: "" in: query name: object_id__lt required: false schema: type: string - description: "" in: query name: object_id__gte required: false schema: type: string - description: "" in: query name: object_id__gt required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: "" in: query name: content_type__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ImageAttachment" type: array required: - count - results type: object description: "" tags: - extras parameters: [] patch: description: "" operationId: extras_image-attachments_bulk_partial_update requestBody: $ref: "#/components/requestBodies/ImageAttachment" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ImageAttachment" description: "" tags: - extras post: description: "" operationId: extras_image-attachments_create requestBody: $ref: "#/components/requestBodies/ImageAttachment" responses: "201": content: application/json: schema: $ref: "#/components/schemas/ImageAttachment" description: "" tags: - extras put: description: "" operationId: extras_image-attachments_bulk_update requestBody: $ref: "#/components/requestBodies/ImageAttachment" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ImageAttachment" description: "" tags: - extras "/extras/image-attachments/{id}/": delete: description: "" operationId: extras_image-attachments_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_image-attachments_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ImageAttachment" description: "" tags: - extras parameters: - description: A unique integer value identifying this image attachment. in: path name: id required: true schema: type: integer patch: description: "" operationId: extras_image-attachments_partial_update requestBody: $ref: "#/components/requestBodies/ImageAttachment" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ImageAttachment" description: "" tags: - extras put: description: "" operationId: extras_image-attachments_update requestBody: $ref: "#/components/requestBodies/ImageAttachment" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ImageAttachment" description: "" tags: - extras /extras/job-results/: get: description: Retrieve a list of job results operationId: extras_job-results_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: interval required: false schema: type: string - description: "" in: query name: status required: false schema: type: string - description: "" in: query name: user required: false schema: type: string - description: "" in: query name: obj_type required: false schema: type: string - description: "" in: query name: name required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: created__before required: false schema: type: string - description: "" in: query name: created__after required: false schema: type: string - description: "" in: query name: scheduled required: false schema: type: string - description: "" in: query name: scheduled__before required: false schema: type: string - description: "" in: query name: scheduled__after required: false schema: type: string - description: "" in: query name: started required: false schema: type: string - description: "" in: query name: started__before required: false schema: type: string - description: "" in: query name: started__after required: false schema: type: string - description: "" in: query name: completed required: false schema: type: string - description: "" in: query name: completed__before required: false schema: type: string - description: "" in: query name: completed__after required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: interval__n required: false schema: type: string - description: "" in: query name: interval__lte required: false schema: type: string - description: "" in: query name: interval__lt required: false schema: type: string - description: "" in: query name: interval__gte required: false schema: type: string - description: "" in: query name: interval__gt required: false schema: type: string - description: "" in: query name: status__n required: false schema: type: string - description: "" in: query name: user__n required: false schema: type: string - description: "" in: query name: obj_type__n required: false schema: type: string - description: "" in: query name: name__n required: false schema: type: string - description: "" in: query name: name__ic required: false schema: type: string - description: "" in: query name: name__nic required: false schema: type: string - description: "" in: query name: name__iew required: false schema: type: string - description: "" in: query name: name__niew required: false schema: type: string - description: "" in: query name: name__isw required: false schema: type: string - description: "" in: query name: name__nisw required: false schema: type: string - description: "" in: query name: name__ie required: false schema: type: string - description: "" in: query name: name__nie required: false schema: type: string - description: "" in: query name: name__empty required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/JobResult" type: array required: - count - results type: object description: "" tags: - extras parameters: [] "/extras/job-results/{id}/": get: description: Retrieve a list of job results operationId: extras_job-results_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/JobResult" description: "" tags: - extras parameters: - description: A unique integer value identifying this job result. in: path name: id required: true schema: type: integer /extras/journal-entries/: delete: description: "" operationId: extras_journal-entries_bulk_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_journal-entries_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: assigned_object_type_id required: false schema: type: string - description: "" in: query name: assigned_object_id required: false schema: type: string - description: "" in: query name: created required: false schema: type: string - description: "" in: query name: kind required: false schema: type: string - description: "" in: query name: last_updated required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: tag required: false schema: type: string - description: "" in: query name: assigned_object_type required: false schema: type: string - description: "" in: query name: created_by_id required: false schema: type: string - description: "" in: query name: created_by required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: assigned_object_type_id__n required: false schema: type: string - description: "" in: query name: assigned_object_id__n required: false schema: type: string - description: "" in: query name: assigned_object_id__lte required: false schema: type: string - description: "" in: query name: assigned_object_id__lt required: false schema: type: string - description: "" in: query name: assigned_object_id__gte required: false schema: type: string - description: "" in: query name: assigned_object_id__gt required: false schema: type: string - description: "" in: query name: kind__n required: false schema: type: string - description: "" in: query name: last_updated__n required: false schema: type: string - description: "" in: query name: last_updated__lte required: false schema: type: string - description: "" in: query name: last_updated__lt required: false schema: type: string - description: "" in: query name: last_updated__gte required: false schema: type: string - description: "" in: query name: last_updated__gt required: false schema: type: string - description: "" in: query name: tag__n required: false schema: type: string - description: "" in: query name: assigned_object_type__n required: false schema: type: string - description: "" in: query name: created_by_id__n required: false schema: type: string - description: "" in: query name: created_by__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/JournalEntry" type: array required: - count - results type: object description: "" tags: - extras parameters: [] patch: description: "" operationId: extras_journal-entries_bulk_partial_update requestBody: $ref: "#/components/requestBodies/WritableJournalEntry" responses: "200": content: application/json: schema: $ref: "#/components/schemas/JournalEntry" description: "" tags: - extras post: description: "" operationId: extras_journal-entries_create requestBody: $ref: "#/components/requestBodies/WritableJournalEntry" responses: "201": content: application/json: schema: $ref: "#/components/schemas/JournalEntry" description: "" tags: - extras put: description: "" operationId: extras_journal-entries_bulk_update requestBody: $ref: "#/components/requestBodies/WritableJournalEntry" responses: "200": content: application/json: schema: $ref: "#/components/schemas/JournalEntry" description: "" tags: - extras "/extras/journal-entries/{id}/": delete: description: "" operationId: extras_journal-entries_delete responses: "204": description: "" tags: - extras get: description: "" operationId: extras_journal-entries_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/JournalEntry" description: "" tags: - extras parameters: - description: A unique integer value identifying this journal entry. in: path name: id required: true schema: type: integer patch: description: "" operationId: extras_journal-entries_partial_update requestBody: $ref: "#/components/requestBodies/WritableJournalEntry" responses: "200": content: application/json: schema: $ref: "#/components/schemas/JournalEntry" description: "" tags: - extras put: description: "" operationId: extras_journal-entries_update requestBody: $ref: "#/components/requestBodies/WritableJournalEntry" responses: "200": content: application/json: schema: $ref: "#/components/schemas/JournalEntry" description: "" tags: - extras /extras/object-changes/: get: description: Retrieve a list of recent changes. operationId: extras_object-changes_list parameters: - description: "" in: query name: id required: false schema: type: string - description: "" in: query name: user required: false schema: type: string - description: "" in: query name: user_name required: false schema: type: string - description: "" in: query name: request_id required: false schema: type: string - description: "" in: query name: action required: false schema: type: string - description: "" in: query name: changed_object_type_id required: false schema: type: string - description: "" in: query name: changed_object_id required: false schema: type: string - description: "" in: query name: object_repr required: false schema: type: string - description: "" in: query name: q required: false schema: type: string - description: "" in: query name: time required: false schema: type: string - description: "" in: query name: changed_object_type required: false schema: type: string - description: "" in: query name: user_id required: false schema: type: string - description: "" in: query name: id__n required: false schema: type: string - description: "" in: query name: id__lte required: false schema: type: string - description: "" in: query name: id__lt required: false schema: type: string - description: "" in: query name: id__gte required: false schema: type: string - description: "" in: query name: id__gt required: false schema: type: string - description: "" in: query name: user__n required: false schema: type: string - description: "" in: query name: user_name__n required: false schema: type: string - description: "" in: query name: user_name__ic required: false schema: type: string - description: "" in: query name: user_name__nic required: false schema: type: string - description: "" in: query name: user_name__iew required: false schema: type: string - description: "" in: query name: user_name__niew required: false schema: type: string - description: "" in: query name: user_name__isw required: false schema: type: string - description: "" in: query name: user_name__nisw required: false schema: type: string - description: "" in: query name: user_name__ie required: false schema: type: string - description: "" in: query name: user_name__nie required: false schema: type: string - description: "" in: query name: user_name__empty required: false schema: type: string - description: "" in: query name: action__n required: false schema: type: string - description: "" in: query name: changed_object_type_id__n required: false schema: type: string - description: "" in: query name: changed_object_id__n required: false schema: type: string - description: "" in: query name: changed_object_id__lte required: false schema: type: string - description: "" in: query name: changed_object_id__lt required: false schema: type: string - description: "" in: query name: changed_object_id__gte required: false schema: type: string - description: "" in: query name: changed_object_id__gt required: false schema: type: string - description: "" in: query name: object_repr__n required: false schema: type: string - description: "" in: query name: object_repr__ic required: false schema: type: string - description: "" in: query name: object_repr__nic required: false schema: type: string - description: "" in: query name: object_repr__iew required: false schema: type: string - description: "" in: query name: object_repr__niew required: false schema: type: string - description: "" in: query name: object_repr__isw required: false schema: type: string - description: "" in: query name: object_repr__nisw required: false schema: type: string - description: "" in: query name: object_repr__ie required: false schema: type: string - description: "" in: query name: object_repr__nie required: false schema: type: string - description: "" in: query name: object_repr__empty required: false schema: type: string - description: "" in: query name: changed_object_type__n required: false schema: type: string - description: "" in: query name: user_id__n required: false schema: type: string - description: Which field to use when ordering the results. in: query name: ordering required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: "200": content: application/json: schema: properties: count: type: integer next: format: uri nullable: true type: string previous: format: uri nullable: true type: string results: items: $ref: "#/components/schemas/ObjectChange" type: array required: - count - results type: object description: "" tags: - extras parameters: [] "/extras/object-changes/{id}/": get: description: Retrieve a list of recent changes. operationId: extras_object-changes_read responses: "200": content: application/json: schema: $ref: "#/components/schemas/ObjectChange" description: "" tags: - extras parameters: - description: A unique integer value identifying this object change. in: path name: id required: true schema: type: integer /extras/reports/: get: description: Compile all reports and their related results (if any). Result data is deferred in the list view. operationId: extras_reports_list responses: "200": description: "" tags: - extras parameters: [] "/extras/reports/{id}/": get: description: Retrieve a single Report identified as ".". operationId: extras_reports_read responses: "200": description: "" tags: - extras parameters: - in: path name: id required: true schema: type: string "/extras/reports/{id}/run/": parameters: - in: path name: id required: true schema: type: string post: description: Run a Report identified as ".