swagger: '2.0' info: title: NetBox API description: API to access NetBox termsOfService: https://github.com/netbox-community/netbox license: name: Apache v2 License version: '3.5' basePath: /api consumes: - application/json produces: - application/json securityDefinitions: Bearer: type: apiKey name: Authorization in: header security: - Bearer: [] paths: /circuits/circuit-terminations/: get: operationId: circuits_circuit-terminations_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: term_side in: query description: '' required: false type: string - name: port_speed in: query description: '' required: false type: string - name: upstream_speed in: query description: '' required: false type: string - name: xconnect_id in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: circuit_id in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: provider_network_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: term_side__n in: query description: '' required: false type: string - name: port_speed__n in: query description: '' required: false type: string - name: port_speed__lte in: query description: '' required: false type: string - name: port_speed__lt in: query description: '' required: false type: string - name: port_speed__gte in: query description: '' required: false type: string - name: port_speed__gt in: query description: '' required: false type: string - name: upstream_speed__n in: query description: '' required: false type: string - name: upstream_speed__lte in: query description: '' required: false type: string - name: upstream_speed__lt in: query description: '' required: false type: string - name: upstream_speed__gte in: query description: '' required: false type: string - name: upstream_speed__gt in: query description: '' required: false type: string - name: xconnect_id__n in: query description: '' required: false type: string - name: xconnect_id__ic in: query description: '' required: false type: string - name: xconnect_id__nic in: query description: '' required: false type: string - name: xconnect_id__iew in: query description: '' required: false type: string - name: xconnect_id__niew in: query description: '' required: false type: string - name: xconnect_id__isw in: query description: '' required: false type: string - name: xconnect_id__nisw in: query description: '' required: false type: string - name: xconnect_id__ie in: query description: '' required: false type: string - name: xconnect_id__nie in: query description: '' required: false type: string - name: xconnect_id__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: circuit_id__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: provider_network_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/CircuitTermination' tags: - circuits post: operationId: circuits_circuit-terminations_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuitTermination' responses: '201': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits put: operationId: circuits_circuit-terminations_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuitTermination' responses: '200': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits patch: operationId: circuits_circuit-terminations_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuitTermination' responses: '200': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits delete: operationId: circuits_circuit-terminations_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: [] /circuits/circuit-terminations/{id}/: get: operationId: circuits_circuit-terminations_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits put: operationId: circuits_circuit-terminations_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuitTermination' responses: '200': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits patch: operationId: circuits_circuit-terminations_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuitTermination' responses: '200': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits delete: operationId: circuits_circuit-terminations_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true type: integer /circuits/circuit-terminations/{id}/paths/: get: operationId: circuits_circuit-terminations_paths description: Return all CablePaths which traverse a given pass-through port. parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/CircuitTermination' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this circuit termination. required: true type: integer /circuits/circuit-types/: get: operationId: circuits_circuit-types_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/CircuitType' tags: - circuits post: operationId: circuits_circuit-types_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CircuitType' responses: '201': description: '' schema: $ref: '#/definitions/CircuitType' tags: - circuits put: operationId: circuits_circuit-types_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CircuitType' responses: '200': description: '' schema: $ref: '#/definitions/CircuitType' tags: - circuits patch: operationId: circuits_circuit-types_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CircuitType' responses: '200': description: '' schema: $ref: '#/definitions/CircuitType' tags: - circuits delete: operationId: circuits_circuit-types_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: [] /circuits/circuit-types/{id}/: get: operationId: circuits_circuit-types_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/CircuitType' tags: - circuits put: operationId: circuits_circuit-types_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CircuitType' responses: '200': description: '' schema: $ref: '#/definitions/CircuitType' tags: - circuits patch: operationId: circuits_circuit-types_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CircuitType' responses: '200': description: '' schema: $ref: '#/definitions/CircuitType' tags: - circuits delete: operationId: circuits_circuit-types_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this circuit type. required: true type: integer /circuits/circuits/: get: operationId: circuits_circuits_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: cid in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: install_date in: query description: '' required: false type: string - name: termination_date in: query description: '' required: false type: string - name: commit_rate in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: provider_id in: query description: '' required: false type: string - name: provider in: query description: '' required: false type: string - name: provider_account_id in: query description: '' required: false type: string - name: provider_network_id in: query description: '' required: false type: string - name: type_id in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: cid__n in: query description: '' required: false type: string - name: cid__ic in: query description: '' required: false type: string - name: cid__nic in: query description: '' required: false type: string - name: cid__iew in: query description: '' required: false type: string - name: cid__niew in: query description: '' required: false type: string - name: cid__isw in: query description: '' required: false type: string - name: cid__nisw in: query description: '' required: false type: string - name: cid__ie in: query description: '' required: false type: string - name: cid__nie in: query description: '' required: false type: string - name: cid__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: install_date__n in: query description: '' required: false type: string - name: install_date__lte in: query description: '' required: false type: string - name: install_date__lt in: query description: '' required: false type: string - name: install_date__gte in: query description: '' required: false type: string - name: install_date__gt in: query description: '' required: false type: string - name: termination_date__n in: query description: '' required: false type: string - name: termination_date__lte in: query description: '' required: false type: string - name: termination_date__lt in: query description: '' required: false type: string - name: termination_date__gte in: query description: '' required: false type: string - name: termination_date__gt in: query description: '' required: false type: string - name: commit_rate__n in: query description: '' required: false type: string - name: commit_rate__lte in: query description: '' required: false type: string - name: commit_rate__lt in: query description: '' required: false type: string - name: commit_rate__gte in: query description: '' required: false type: string - name: commit_rate__gt in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: provider_id__n in: query description: '' required: false type: string - name: provider__n in: query description: '' required: false type: string - name: provider_account_id__n in: query description: '' required: false type: string - name: provider_network_id__n in: query description: '' required: false type: string - name: type_id__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Circuit' tags: - circuits post: operationId: circuits_circuits_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuit' responses: '201': description: '' schema: $ref: '#/definitions/Circuit' tags: - circuits put: operationId: circuits_circuits_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuit' responses: '200': description: '' schema: $ref: '#/definitions/Circuit' tags: - circuits patch: operationId: circuits_circuits_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuit' responses: '200': description: '' schema: $ref: '#/definitions/Circuit' tags: - circuits delete: operationId: circuits_circuits_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: [] /circuits/circuits/{id}/: get: operationId: circuits_circuits_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Circuit' tags: - circuits put: operationId: circuits_circuits_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuit' responses: '200': description: '' schema: $ref: '#/definitions/Circuit' tags: - circuits patch: operationId: circuits_circuits_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCircuit' responses: '200': description: '' schema: $ref: '#/definitions/Circuit' tags: - circuits delete: operationId: circuits_circuits_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this circuit. required: true type: integer /circuits/provider-accounts/: get: operationId: circuits_provider-accounts_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: account in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: provider_id in: query description: '' required: false type: string - name: provider in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: account__n in: query description: '' required: false type: string - name: account__ic in: query description: '' required: false type: string - name: account__nic in: query description: '' required: false type: string - name: account__iew in: query description: '' required: false type: string - name: account__niew in: query description: '' required: false type: string - name: account__isw in: query description: '' required: false type: string - name: account__nisw in: query description: '' required: false type: string - name: account__ie in: query description: '' required: false type: string - name: account__nie in: query description: '' required: false type: string - name: account__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: provider_id__n in: query description: '' required: false type: string - name: provider__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ProviderAccount' tags: - circuits post: operationId: circuits_provider-accounts_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderAccount' responses: '201': description: '' schema: $ref: '#/definitions/ProviderAccount' tags: - circuits put: operationId: circuits_provider-accounts_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderAccount' responses: '200': description: '' schema: $ref: '#/definitions/ProviderAccount' tags: - circuits patch: operationId: circuits_provider-accounts_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderAccount' responses: '200': description: '' schema: $ref: '#/definitions/ProviderAccount' tags: - circuits delete: operationId: circuits_provider-accounts_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: [] /circuits/provider-accounts/{id}/: get: operationId: circuits_provider-accounts_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ProviderAccount' tags: - circuits put: operationId: circuits_provider-accounts_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderAccount' responses: '200': description: '' schema: $ref: '#/definitions/ProviderAccount' tags: - circuits patch: operationId: circuits_provider-accounts_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderAccount' responses: '200': description: '' schema: $ref: '#/definitions/ProviderAccount' tags: - circuits delete: operationId: circuits_provider-accounts_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this provider account. required: true type: integer /circuits/provider-networks/: get: operationId: circuits_provider-networks_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: service_id in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: provider_id in: query description: '' required: false type: string - name: provider in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: service_id__n in: query description: '' required: false type: string - name: service_id__ic in: query description: '' required: false type: string - name: service_id__nic in: query description: '' required: false type: string - name: service_id__iew in: query description: '' required: false type: string - name: service_id__niew in: query description: '' required: false type: string - name: service_id__isw in: query description: '' required: false type: string - name: service_id__nisw in: query description: '' required: false type: string - name: service_id__ie in: query description: '' required: false type: string - name: service_id__nie in: query description: '' required: false type: string - name: service_id__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: provider_id__n in: query description: '' required: false type: string - name: provider__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ProviderNetwork' tags: - circuits post: operationId: circuits_provider-networks_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderNetwork' responses: '201': description: '' schema: $ref: '#/definitions/ProviderNetwork' tags: - circuits put: operationId: circuits_provider-networks_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderNetwork' responses: '200': description: '' schema: $ref: '#/definitions/ProviderNetwork' tags: - circuits patch: operationId: circuits_provider-networks_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderNetwork' responses: '200': description: '' schema: $ref: '#/definitions/ProviderNetwork' tags: - circuits delete: operationId: circuits_provider-networks_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: [] /circuits/provider-networks/{id}/: get: operationId: circuits_provider-networks_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ProviderNetwork' tags: - circuits put: operationId: circuits_provider-networks_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderNetwork' responses: '200': description: '' schema: $ref: '#/definitions/ProviderNetwork' tags: - circuits patch: operationId: circuits_provider-networks_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProviderNetwork' responses: '200': description: '' schema: $ref: '#/definitions/ProviderNetwork' tags: - circuits delete: operationId: circuits_provider-networks_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this provider network. required: true type: integer /circuits/providers/: get: operationId: circuits_providers_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: asn_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: asn_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Provider' tags: - circuits post: operationId: circuits_providers_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProvider' responses: '201': description: '' schema: $ref: '#/definitions/Provider' tags: - circuits put: operationId: circuits_providers_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProvider' responses: '200': description: '' schema: $ref: '#/definitions/Provider' tags: - circuits patch: operationId: circuits_providers_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProvider' responses: '200': description: '' schema: $ref: '#/definitions/Provider' tags: - circuits delete: operationId: circuits_providers_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: [] /circuits/providers/{id}/: get: operationId: circuits_providers_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Provider' tags: - circuits put: operationId: circuits_providers_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProvider' responses: '200': description: '' schema: $ref: '#/definitions/Provider' tags: - circuits patch: operationId: circuits_providers_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableProvider' responses: '200': description: '' schema: $ref: '#/definitions/Provider' tags: - circuits delete: operationId: circuits_providers_delete description: '' parameters: [] responses: '204': description: '' tags: - circuits parameters: - name: id in: path description: A unique integer value identifying this provider. required: true type: integer /core/data-files/: get: operationId: core_data-files_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: path in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: size in: query description: '' required: false type: string - name: hash in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: source_id in: query description: '' required: false type: string - name: source in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: path__n in: query description: '' required: false type: string - name: path__ic in: query description: '' required: false type: string - name: path__nic in: query description: '' required: false type: string - name: path__iew in: query description: '' required: false type: string - name: path__niew in: query description: '' required: false type: string - name: path__isw in: query description: '' required: false type: string - name: path__nisw in: query description: '' required: false type: string - name: path__ie in: query description: '' required: false type: string - name: path__nie in: query description: '' required: false type: string - name: path__empty in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: size__n in: query description: '' required: false type: string - name: size__lte in: query description: '' required: false type: string - name: size__lt in: query description: '' required: false type: string - name: size__gte in: query description: '' required: false type: string - name: size__gt in: query description: '' required: false type: string - name: hash__n in: query description: '' required: false type: string - name: hash__ic in: query description: '' required: false type: string - name: hash__nic in: query description: '' required: false type: string - name: hash__iew in: query description: '' required: false type: string - name: hash__niew in: query description: '' required: false type: string - name: hash__isw in: query description: '' required: false type: string - name: hash__nisw in: query description: '' required: false type: string - name: hash__ie in: query description: '' required: false type: string - name: hash__nie in: query description: '' required: false type: string - name: hash__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: source_id__n in: query description: '' required: false type: string - name: source__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/DataFile' tags: - core parameters: [] /core/data-files/{id}/: get: operationId: core_data-files_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/DataFile' tags: - core parameters: - name: id in: path description: A unique integer value identifying this data file. required: true type: integer /core/data-sources/: get: operationId: core_data-sources_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: enabled in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/DataSource' tags: - core post: operationId: core_data-sources_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDataSource' responses: '201': description: '' schema: $ref: '#/definitions/DataSource' tags: - core put: operationId: core_data-sources_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDataSource' responses: '200': description: '' schema: $ref: '#/definitions/DataSource' tags: - core patch: operationId: core_data-sources_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDataSource' responses: '200': description: '' schema: $ref: '#/definitions/DataSource' tags: - core delete: operationId: core_data-sources_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - core parameters: [] /core/data-sources/{id}/: get: operationId: core_data-sources_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/DataSource' tags: - core put: operationId: core_data-sources_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDataSource' responses: '200': description: '' schema: $ref: '#/definitions/DataSource' tags: - core patch: operationId: core_data-sources_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDataSource' responses: '200': description: '' schema: $ref: '#/definitions/DataSource' tags: - core delete: operationId: core_data-sources_delete description: '' parameters: [] responses: '204': description: '' tags: - core parameters: - name: id in: path description: A unique integer value identifying this data source. required: true type: integer /core/data-sources/{id}/sync/: post: operationId: core_data-sources_sync description: Enqueue a job to synchronize the DataSource. parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDataSource' responses: '201': description: '' schema: $ref: '#/definitions/DataSource' tags: - core parameters: - name: id in: path description: A unique integer value identifying this data source. required: true type: integer /core/jobs/: get: operationId: core_jobs_list description: Retrieve a list of job results parameters: - name: id in: query description: '' required: false type: string - name: object_type in: query description: '' required: false type: string - name: object_id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: interval in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: user in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: created__before in: query description: '' required: false type: string - name: created__after in: query description: '' required: false type: string - name: scheduled in: query description: '' required: false type: string - name: scheduled__before in: query description: '' required: false type: string - name: scheduled__after in: query description: '' required: false type: string - name: started in: query description: '' required: false type: string - name: started__before in: query description: '' required: false type: string - name: started__after in: query description: '' required: false type: string - name: completed in: query description: '' required: false type: string - name: completed__before in: query description: '' required: false type: string - name: completed__after in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: object_type__n in: query description: '' required: false type: string - name: object_id__n in: query description: '' required: false type: string - name: object_id__lte in: query description: '' required: false type: string - name: object_id__lt in: query description: '' required: false type: string - name: object_id__gte in: query description: '' required: false type: string - name: object_id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: interval__n in: query description: '' required: false type: string - name: interval__lte in: query description: '' required: false type: string - name: interval__lt in: query description: '' required: false type: string - name: interval__gte in: query description: '' required: false type: string - name: interval__gt in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: user__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Job' tags: - core parameters: [] /core/jobs/{id}/: get: operationId: core_jobs_read description: Retrieve a list of job results parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Job' tags: - core parameters: - name: id in: path description: A unique integer value identifying this job. required: true type: integer /dcim/cable-terminations/: get: operationId: dcim_cable-terminations_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: cable in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: termination_type in: query description: '' required: false type: string - name: termination_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: cable__n in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: termination_type__n in: query description: '' required: false type: string - name: termination_id__n in: query description: '' required: false type: string - name: termination_id__lte in: query description: '' required: false type: string - name: termination_id__lt in: query description: '' required: false type: string - name: termination_id__gte in: query description: '' required: false type: string - name: termination_id__gt in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/CableTermination' tags: - dcim post: operationId: dcim_cable-terminations_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CableTermination' responses: '201': description: '' schema: $ref: '#/definitions/CableTermination' tags: - dcim put: operationId: dcim_cable-terminations_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CableTermination' responses: '200': description: '' schema: $ref: '#/definitions/CableTermination' tags: - dcim patch: operationId: dcim_cable-terminations_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CableTermination' responses: '200': description: '' schema: $ref: '#/definitions/CableTermination' tags: - dcim delete: operationId: dcim_cable-terminations_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/cable-terminations/{id}/: get: operationId: dcim_cable-terminations_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/CableTermination' tags: - dcim put: operationId: dcim_cable-terminations_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CableTermination' responses: '200': description: '' schema: $ref: '#/definitions/CableTermination' tags: - dcim patch: operationId: dcim_cable-terminations_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CableTermination' responses: '200': description: '' schema: $ref: '#/definitions/CableTermination' tags: - dcim delete: operationId: dcim_cable-terminations_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this cable termination. required: true type: integer /dcim/cables/: get: operationId: dcim_cables_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: length in: query description: '' required: false type: string - name: length_unit in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: termination_a_type in: query description: '' required: false type: string - name: termination_a_id in: query description: '' required: false type: string - name: termination_b_type in: query description: '' required: false type: string - name: termination_b_id in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: length__n in: query description: '' required: false type: string - name: length__lte in: query description: '' required: false type: string - name: length__lt in: query description: '' required: false type: string - name: length__gte in: query description: '' required: false type: string - name: length__gt in: query description: '' required: false type: string - name: length_unit__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: termination_a_type__n in: query description: '' required: false type: string - name: termination_a_id__n in: query description: '' required: false type: string - name: termination_a_id__lte in: query description: '' required: false type: string - name: termination_a_id__lt in: query description: '' required: false type: string - name: termination_a_id__gte in: query description: '' required: false type: string - name: termination_a_id__gt in: query description: '' required: false type: string - name: termination_b_type__n in: query description: '' required: false type: string - name: termination_b_id__n in: query description: '' required: false type: string - name: termination_b_id__lte in: query description: '' required: false type: string - name: termination_b_id__lt in: query description: '' required: false type: string - name: termination_b_id__gte in: query description: '' required: false type: string - name: termination_b_id__gt in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Cable' tags: - dcim post: operationId: dcim_cables_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCable' responses: '201': description: '' schema: $ref: '#/definitions/Cable' tags: - dcim put: operationId: dcim_cables_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCable' responses: '200': description: '' schema: $ref: '#/definitions/Cable' tags: - dcim patch: operationId: dcim_cables_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCable' responses: '200': description: '' schema: $ref: '#/definitions/Cable' tags: - dcim delete: operationId: dcim_cables_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/cables/{id}/: get: operationId: dcim_cables_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Cable' tags: - dcim put: operationId: dcim_cables_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCable' responses: '200': description: '' schema: $ref: '#/definitions/Cable' tags: - dcim patch: operationId: dcim_cables_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCable' responses: '200': description: '' schema: $ref: '#/definitions/Cable' tags: - dcim delete: operationId: dcim_cables_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this cable. required: true type: integer /dcim/connected-device/: get: operationId: dcim_connected-device_list description: |- This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer 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 parameters: - name: peer_device in: query description: The name of the peer device required: true type: string - name: peer_interface in: query description: The name of the peer interface required: true type: string responses: '200': description: '' schema: $ref: '#/definitions/Device' tags: - dcim parameters: [] /dcim/console-port-templates/: get: operationId: dcim_console-port-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim post: operationId: dcim_console-port-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePortTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim put: operationId: dcim_console-port-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim patch: operationId: dcim_console-port-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim delete: operationId: dcim_console-port-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/console-port-templates/{id}/: get: operationId: dcim_console-port-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim put: operationId: dcim_console-port-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim patch: operationId: dcim_console-port-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePortTemplate' tags: - dcim delete: operationId: dcim_console-port-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this console port template. required: true type: integer /dcim/console-ports/: get: operationId: dcim_console-ports_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: connected in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ConsolePort' tags: - dcim post: operationId: dcim_console-ports_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePort' responses: '201': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim put: operationId: dcim_console-ports_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePort' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim patch: operationId: dcim_console-ports_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePort' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim delete: operationId: dcim_console-ports_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/console-ports/{id}/: get: operationId: dcim_console-ports_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim put: operationId: dcim_console-ports_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePort' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim patch: operationId: dcim_console-ports_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsolePort' responses: '200': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim delete: operationId: dcim_console-ports_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this console port. required: true type: integer /dcim/console-ports/{id}/trace/: get: operationId: dcim_console-ports_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConsolePort' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this console port. required: true type: integer /dcim/console-server-port-templates/: get: operationId: dcim_console-server-port-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim post: operationId: dcim_console-server-port-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPortTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim put: operationId: dcim_console-server-port-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim patch: operationId: dcim_console-server-port-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim delete: operationId: dcim_console-server-port-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/console-server-port-templates/{id}/: get: operationId: dcim_console-server-port-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim put: operationId: dcim_console-server-port-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim patch: operationId: dcim_console-server-port-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPortTemplate' tags: - dcim delete: operationId: dcim_console-server-port-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this console server port template. required: true type: integer /dcim/console-server-ports/: get: operationId: dcim_console-server-ports_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: connected in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ConsoleServerPort' tags: - dcim post: operationId: dcim_console-server-ports_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPort' responses: '201': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim put: operationId: dcim_console-server-ports_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPort' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim patch: operationId: dcim_console-server-ports_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPort' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim delete: operationId: dcim_console-server-ports_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/console-server-ports/{id}/: get: operationId: dcim_console-server-ports_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim put: operationId: dcim_console-server-ports_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPort' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim patch: operationId: dcim_console-server-ports_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConsoleServerPort' responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim delete: operationId: dcim_console-server-ports_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this console server port. required: true type: integer /dcim/console-server-ports/{id}/trace/: get: operationId: dcim_console-server-ports_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConsoleServerPort' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this console server port. required: true type: integer /dcim/device-bay-templates/: get: operationId: dcim_device-bay-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim post: operationId: dcim_device-bay-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBayTemplate' responses: '201': description: '' schema: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim put: operationId: dcim_device-bay-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim patch: operationId: dcim_device-bay-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim delete: operationId: dcim_device-bay-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/device-bay-templates/{id}/: get: operationId: dcim_device-bay-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim put: operationId: dcim_device-bay-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim patch: operationId: dcim_device-bay-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBayTemplate' tags: - dcim delete: operationId: dcim_device-bay-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this device bay template. required: true type: integer /dcim/device-bays/: get: operationId: dcim_device-bays_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/DeviceBay' tags: - dcim post: operationId: dcim_device-bays_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBay' responses: '201': description: '' schema: $ref: '#/definitions/DeviceBay' tags: - dcim put: operationId: dcim_device-bays_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBay' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBay' tags: - dcim patch: operationId: dcim_device-bays_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBay' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBay' tags: - dcim delete: operationId: dcim_device-bays_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/device-bays/{id}/: get: operationId: dcim_device-bays_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/DeviceBay' tags: - dcim put: operationId: dcim_device-bays_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBay' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBay' tags: - dcim patch: operationId: dcim_device-bays_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceBay' responses: '200': description: '' schema: $ref: '#/definitions/DeviceBay' tags: - dcim delete: operationId: dcim_device-bays_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this device bay. required: true type: integer /dcim/device-roles/: get: operationId: dcim_device-roles_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: vm_role in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: config_template_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: config_template_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/DeviceRole' tags: - dcim post: operationId: dcim_device-roles_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceRole' responses: '201': description: '' schema: $ref: '#/definitions/DeviceRole' tags: - dcim put: operationId: dcim_device-roles_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceRole' responses: '200': description: '' schema: $ref: '#/definitions/DeviceRole' tags: - dcim patch: operationId: dcim_device-roles_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceRole' responses: '200': description: '' schema: $ref: '#/definitions/DeviceRole' tags: - dcim delete: operationId: dcim_device-roles_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/device-roles/{id}/: get: operationId: dcim_device-roles_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/DeviceRole' tags: - dcim put: operationId: dcim_device-roles_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceRole' responses: '200': description: '' schema: $ref: '#/definitions/DeviceRole' tags: - dcim patch: operationId: dcim_device-roles_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceRole' responses: '200': description: '' schema: $ref: '#/definitions/DeviceRole' tags: - dcim delete: operationId: dcim_device-roles_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this device role. required: true type: integer /dcim/device-types/: get: operationId: dcim_device-types_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: model in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: part_number in: query description: '' required: false type: string - name: u_height in: query description: '' required: false type: string - name: is_full_depth in: query description: '' required: false type: string - name: subdevice_role in: query description: '' required: false type: string - name: airflow in: query description: '' required: false type: string - name: weight in: query description: '' required: false type: string - name: weight_unit in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: default_platform_id in: query description: '' required: false type: string - name: default_platform in: query description: '' required: false type: string - name: has_front_image in: query description: '' required: false type: string - name: has_rear_image in: query description: '' required: false type: string - name: console_ports in: query description: '' required: false type: string - name: console_server_ports in: query description: '' required: false type: string - name: power_ports in: query description: '' required: false type: string - name: power_outlets in: query description: '' required: false type: string - name: interfaces in: query description: '' required: false type: string - name: pass_through_ports in: query description: '' required: false type: string - name: module_bays in: query description: '' required: false type: string - name: device_bays in: query description: '' required: false type: string - name: inventory_items in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: model__n in: query description: '' required: false type: string - name: model__ic in: query description: '' required: false type: string - name: model__nic in: query description: '' required: false type: string - name: model__iew in: query description: '' required: false type: string - name: model__niew in: query description: '' required: false type: string - name: model__isw in: query description: '' required: false type: string - name: model__nisw in: query description: '' required: false type: string - name: model__ie in: query description: '' required: false type: string - name: model__nie in: query description: '' required: false type: string - name: model__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: part_number__n in: query description: '' required: false type: string - name: part_number__ic in: query description: '' required: false type: string - name: part_number__nic in: query description: '' required: false type: string - name: part_number__iew in: query description: '' required: false type: string - name: part_number__niew in: query description: '' required: false type: string - name: part_number__isw in: query description: '' required: false type: string - name: part_number__nisw in: query description: '' required: false type: string - name: part_number__ie in: query description: '' required: false type: string - name: part_number__nie in: query description: '' required: false type: string - name: part_number__empty in: query description: '' required: false type: string - name: u_height__n in: query description: '' required: false type: string - name: u_height__lte in: query description: '' required: false type: string - name: u_height__lt in: query description: '' required: false type: string - name: u_height__gte in: query description: '' required: false type: string - name: u_height__gt in: query description: '' required: false type: string - name: subdevice_role__n in: query description: '' required: false type: string - name: airflow__n in: query description: '' required: false type: string - name: weight__n in: query description: '' required: false type: string - name: weight__lte in: query description: '' required: false type: string - name: weight__lt in: query description: '' required: false type: string - name: weight__gte in: query description: '' required: false type: string - name: weight__gt in: query description: '' required: false type: string - name: weight_unit__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: default_platform_id__n in: query description: '' required: false type: string - name: default_platform__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/DeviceType' tags: - dcim post: operationId: dcim_device-types_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceType' responses: '201': description: '' schema: $ref: '#/definitions/DeviceType' tags: - dcim put: operationId: dcim_device-types_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceType' responses: '200': description: '' schema: $ref: '#/definitions/DeviceType' tags: - dcim patch: operationId: dcim_device-types_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceType' responses: '200': description: '' schema: $ref: '#/definitions/DeviceType' tags: - dcim delete: operationId: dcim_device-types_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/device-types/{id}/: get: operationId: dcim_device-types_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/DeviceType' tags: - dcim put: operationId: dcim_device-types_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceType' responses: '200': description: '' schema: $ref: '#/definitions/DeviceType' tags: - dcim patch: operationId: dcim_device-types_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableDeviceType' responses: '200': description: '' schema: $ref: '#/definitions/DeviceType' tags: - dcim delete: operationId: dcim_device-types_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this device type. required: true type: integer /dcim/devices/: get: operationId: dcim_devices_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: asset_tag in: query description: '' required: false type: string - name: face in: query description: '' required: false type: string - name: position in: query description: '' required: false type: string - name: airflow in: query description: '' required: false type: string - name: vc_position in: query description: '' required: false type: string - name: vc_priority in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: local_context_data in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: device_type in: query description: '' required: false type: string - name: device_type_id in: query description: '' required: false type: string - name: role_id in: query description: '' required: false type: string - name: role in: query description: '' required: false type: string - name: parent_device_id in: query description: '' required: false type: string - name: platform_id in: query description: '' required: false type: string - name: platform in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: cluster_id in: query description: '' required: false type: string - name: model in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: is_full_depth in: query description: '' required: false type: string - name: mac_address in: query description: '' required: false type: string - name: serial in: query description: '' required: false type: string - name: has_primary_ip in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis_member in: query description: '' required: false type: string - name: config_template_id in: query description: '' required: false type: string - name: console_ports in: query description: '' required: false type: string - name: console_server_ports in: query description: '' required: false type: string - name: power_ports in: query description: '' required: false type: string - name: power_outlets in: query description: '' required: false type: string - name: interfaces in: query description: '' required: false type: string - name: pass_through_ports in: query description: '' required: false type: string - name: module_bays in: query description: '' required: false type: string - name: device_bays in: query description: '' required: false type: string - name: primary_ip4_id in: query description: '' required: false type: string - name: primary_ip6_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: asset_tag__n in: query description: '' required: false type: string - name: asset_tag__ic in: query description: '' required: false type: string - name: asset_tag__nic in: query description: '' required: false type: string - name: asset_tag__iew in: query description: '' required: false type: string - name: asset_tag__niew in: query description: '' required: false type: string - name: asset_tag__isw in: query description: '' required: false type: string - name: asset_tag__nisw in: query description: '' required: false type: string - name: asset_tag__ie in: query description: '' required: false type: string - name: asset_tag__nie in: query description: '' required: false type: string - name: asset_tag__empty in: query description: '' required: false type: string - name: face__n in: query description: '' required: false type: string - name: position__n in: query description: '' required: false type: string - name: position__lte in: query description: '' required: false type: string - name: position__lt in: query description: '' required: false type: string - name: position__gte in: query description: '' required: false type: string - name: position__gt in: query description: '' required: false type: string - name: airflow__n in: query description: '' required: false type: string - name: vc_position__n in: query description: '' required: false type: string - name: vc_position__lte in: query description: '' required: false type: string - name: vc_position__lt in: query description: '' required: false type: string - name: vc_position__gte in: query description: '' required: false type: string - name: vc_position__gt in: query description: '' required: false type: string - name: vc_priority__n in: query description: '' required: false type: string - name: vc_priority__lte in: query description: '' required: false type: string - name: vc_priority__lt in: query description: '' required: false type: string - name: vc_priority__gte in: query description: '' required: false type: string - name: vc_priority__gt in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: device_type__n in: query description: '' required: false type: string - name: device_type_id__n in: query description: '' required: false type: string - name: role_id__n in: query description: '' required: false type: string - name: role__n in: query description: '' required: false type: string - name: parent_device_id__n in: query description: '' required: false type: string - name: platform_id__n in: query description: '' required: false type: string - name: platform__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: cluster_id__n in: query description: '' required: false type: string - name: model__n in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: mac_address__n in: query description: '' required: false type: string - name: mac_address__ic in: query description: '' required: false type: string - name: mac_address__nic in: query description: '' required: false type: string - name: mac_address__iew in: query description: '' required: false type: string - name: mac_address__niew in: query description: '' required: false type: string - name: mac_address__isw in: query description: '' required: false type: string - name: mac_address__nisw in: query description: '' required: false type: string - name: mac_address__ie in: query description: '' required: false type: string - name: mac_address__nie in: query description: '' required: false type: string - name: serial__n in: query description: '' required: false type: string - name: serial__ic in: query description: '' required: false type: string - name: serial__nic in: query description: '' required: false type: string - name: serial__iew in: query description: '' required: false type: string - name: serial__niew in: query description: '' required: false type: string - name: serial__isw in: query description: '' required: false type: string - name: serial__nisw in: query description: '' required: false type: string - name: serial__ie in: query description: '' required: false type: string - name: serial__nie in: query description: '' required: false type: string - name: serial__empty in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: config_template_id__n in: query description: '' required: false type: string - name: primary_ip4_id__n in: query description: '' required: false type: string - name: primary_ip6_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' tags: - dcim post: operationId: dcim_devices_create description: '' parameters: [] responses: '201': description: '' tags: - dcim put: operationId: dcim_devices_bulk_update description: '' parameters: [] responses: '200': description: '' tags: - dcim patch: operationId: dcim_devices_bulk_partial_update description: '' parameters: [] responses: '200': description: '' tags: - dcim delete: operationId: dcim_devices_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/devices/{id}/: get: operationId: dcim_devices_read description: '' parameters: [] responses: '200': description: '' tags: - dcim put: operationId: dcim_devices_update description: '' parameters: [] responses: '200': description: '' tags: - dcim patch: operationId: dcim_devices_partial_update description: '' parameters: [] responses: '200': description: '' tags: - dcim delete: operationId: dcim_devices_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this device. required: true type: integer /dcim/devices/{id}/render-config/: post: operationId: dcim_devices_render_config description: Resolve and render the preferred ConfigTemplate for this Device. parameters: [] responses: '201': description: '' produces: - application/json - text/plain tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this device. required: true type: integer /dcim/front-port-templates/: get: operationId: dcim_front-port-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/FrontPortTemplate' tags: - dcim post: operationId: dcim_front-port-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPortTemplate' responses: '201': description: '' schema: $ref: '#/definitions/FrontPortTemplate' tags: - dcim put: operationId: dcim_front-port-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/FrontPortTemplate' tags: - dcim patch: operationId: dcim_front-port-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/FrontPortTemplate' tags: - dcim delete: operationId: dcim_front-port-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/front-port-templates/{id}/: get: operationId: dcim_front-port-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/FrontPortTemplate' tags: - dcim put: operationId: dcim_front-port-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/FrontPortTemplate' tags: - dcim patch: operationId: dcim_front-port-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/FrontPortTemplate' tags: - dcim delete: operationId: dcim_front-port-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this front port template. required: true type: integer /dcim/front-ports/: get: operationId: dcim_front-ports_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/FrontPort' tags: - dcim post: operationId: dcim_front-ports_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPort' responses: '201': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim put: operationId: dcim_front-ports_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPort' responses: '200': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim patch: operationId: dcim_front-ports_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPort' responses: '200': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim delete: operationId: dcim_front-ports_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/front-ports/{id}/: get: operationId: dcim_front-ports_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim put: operationId: dcim_front-ports_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPort' responses: '200': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim patch: operationId: dcim_front-ports_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableFrontPort' responses: '200': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim delete: operationId: dcim_front-ports_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this front port. required: true type: integer /dcim/front-ports/{id}/paths/: get: operationId: dcim_front-ports_paths description: Return all CablePaths which traverse a given pass-through port. parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/FrontPort' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this front port. required: true type: integer /dcim/interface-templates/: get: operationId: dcim_interface-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: enabled in: query description: '' required: false type: string - name: mgmt_only in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: bridge_id in: query description: '' required: false type: string - name: poe_mode in: query description: '' required: false type: string - name: poe_type in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: bridge_id__n in: query description: '' required: false type: string - name: poe_mode__n in: query description: '' required: false type: string - name: poe_type__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/InterfaceTemplate' tags: - dcim post: operationId: dcim_interface-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterfaceTemplate' responses: '201': description: '' schema: $ref: '#/definitions/InterfaceTemplate' tags: - dcim put: operationId: dcim_interface-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterfaceTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InterfaceTemplate' tags: - dcim patch: operationId: dcim_interface-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterfaceTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InterfaceTemplate' tags: - dcim delete: operationId: dcim_interface-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/interface-templates/{id}/: get: operationId: dcim_interface-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/InterfaceTemplate' tags: - dcim put: operationId: dcim_interface-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterfaceTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InterfaceTemplate' tags: - dcim patch: operationId: dcim_interface-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterfaceTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InterfaceTemplate' tags: - dcim delete: operationId: dcim_interface-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this interface template. required: true type: integer /dcim/interfaces/: get: operationId: dcim_interfaces_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: enabled in: query description: '' required: false type: string - name: mtu in: query description: '' required: false type: string - name: mgmt_only in: query description: '' required: false type: string - name: poe_mode in: query description: '' required: false type: string - name: poe_type in: query description: '' required: false type: string - name: mode in: query description: '' required: false type: string - name: rf_role in: query description: '' required: false type: string - name: rf_channel in: query description: '' required: false type: string - name: rf_channel_frequency in: query description: '' required: false type: string - name: rf_channel_width in: query description: '' required: false type: string - name: tx_power in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: connected in: query description: '' required: false type: string - name: kind in: query description: '' required: false type: string - name: parent_id in: query description: '' required: false type: string - name: bridge_id in: query description: '' required: false type: string - name: lag_id in: query description: '' required: false type: string - name: speed in: query description: '' required: false type: string - name: duplex in: query description: '' required: false type: string - name: mac_address in: query description: '' required: false type: string - name: wwn in: query description: '' required: false type: string - name: vlan_id in: query description: '' required: false type: string - name: vlan in: query description: '' required: false type: string - name: vrf_id in: query description: '' required: false type: string - name: vrf in: query description: '' required: false type: string - name: vdc_id in: query description: '' required: false type: string - name: vdc_identifier in: query description: '' required: false type: string - name: vdc in: query description: '' required: false type: string - name: l2vpn_id in: query description: '' required: false type: string - name: l2vpn in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: mtu__n in: query description: '' required: false type: string - name: mtu__lte in: query description: '' required: false type: string - name: mtu__lt in: query description: '' required: false type: string - name: mtu__gte in: query description: '' required: false type: string - name: mtu__gt in: query description: '' required: false type: string - name: poe_mode__n in: query description: '' required: false type: string - name: poe_type__n in: query description: '' required: false type: string - name: mode__n in: query description: '' required: false type: string - name: rf_role__n in: query description: '' required: false type: string - name: rf_channel__n in: query description: '' required: false type: string - name: rf_channel_frequency__n in: query description: '' required: false type: string - name: rf_channel_frequency__lte in: query description: '' required: false type: string - name: rf_channel_frequency__lt in: query description: '' required: false type: string - name: rf_channel_frequency__gte in: query description: '' required: false type: string - name: rf_channel_frequency__gt in: query description: '' required: false type: string - name: rf_channel_width__n in: query description: '' required: false type: string - name: rf_channel_width__lte in: query description: '' required: false type: string - name: rf_channel_width__lt in: query description: '' required: false type: string - name: rf_channel_width__gte in: query description: '' required: false type: string - name: rf_channel_width__gt in: query description: '' required: false type: string - name: tx_power__n in: query description: '' required: false type: string - name: tx_power__lte in: query description: '' required: false type: string - name: tx_power__lt in: query description: '' required: false type: string - name: tx_power__gte in: query description: '' required: false type: string - name: tx_power__gt in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: parent_id__n in: query description: '' required: false type: string - name: bridge_id__n in: query description: '' required: false type: string - name: lag_id__n in: query description: '' required: false type: string - name: speed__n in: query description: '' required: false type: string - name: speed__lte in: query description: '' required: false type: string - name: speed__lt in: query description: '' required: false type: string - name: speed__gte in: query description: '' required: false type: string - name: speed__gt in: query description: '' required: false type: string - name: duplex__n in: query description: '' required: false type: string - name: mac_address__n in: query description: '' required: false type: string - name: mac_address__ic in: query description: '' required: false type: string - name: mac_address__nic in: query description: '' required: false type: string - name: mac_address__iew in: query description: '' required: false type: string - name: mac_address__niew in: query description: '' required: false type: string - name: mac_address__isw in: query description: '' required: false type: string - name: mac_address__nisw in: query description: '' required: false type: string - name: mac_address__ie in: query description: '' required: false type: string - name: mac_address__nie in: query description: '' required: false type: string - name: wwn__n in: query description: '' required: false type: string - name: wwn__ic in: query description: '' required: false type: string - name: wwn__nic in: query description: '' required: false type: string - name: wwn__iew in: query description: '' required: false type: string - name: wwn__niew in: query description: '' required: false type: string - name: wwn__isw in: query description: '' required: false type: string - name: wwn__nisw in: query description: '' required: false type: string - name: wwn__ie in: query description: '' required: false type: string - name: wwn__nie in: query description: '' required: false type: string - name: vrf_id__n in: query description: '' required: false type: string - name: vrf__n in: query description: '' required: false type: string - name: vdc_id__n in: query description: '' required: false type: string - name: vdc_identifier__n in: query description: '' required: false type: string - name: vdc__n in: query description: '' required: false type: string - name: l2vpn_id__n in: query description: '' required: false type: string - name: l2vpn__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Interface' tags: - dcim post: operationId: dcim_interfaces_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterface' responses: '201': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim put: operationId: dcim_interfaces_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterface' responses: '200': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim patch: operationId: dcim_interfaces_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterface' responses: '200': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim delete: operationId: dcim_interfaces_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/interfaces/{id}/: get: operationId: dcim_interfaces_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim put: operationId: dcim_interfaces_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterface' responses: '200': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim patch: operationId: dcim_interfaces_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInterface' responses: '200': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim delete: operationId: dcim_interfaces_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this interface. required: true type: integer /dcim/interfaces/{id}/trace/: get: operationId: dcim_interfaces_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Interface' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this interface. required: true type: integer /dcim/inventory-item-roles/: get: operationId: dcim_inventory-item-roles_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/InventoryItemRole' tags: - dcim post: operationId: dcim_inventory-item-roles_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/InventoryItemRole' responses: '201': description: '' schema: $ref: '#/definitions/InventoryItemRole' tags: - dcim put: operationId: dcim_inventory-item-roles_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/InventoryItemRole' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemRole' tags: - dcim patch: operationId: dcim_inventory-item-roles_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/InventoryItemRole' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemRole' tags: - dcim delete: operationId: dcim_inventory-item-roles_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/inventory-item-roles/{id}/: get: operationId: dcim_inventory-item-roles_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemRole' tags: - dcim put: operationId: dcim_inventory-item-roles_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/InventoryItemRole' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemRole' tags: - dcim patch: operationId: dcim_inventory-item-roles_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/InventoryItemRole' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemRole' tags: - dcim delete: operationId: dcim_inventory-item-roles_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this inventory item role. required: true type: integer /dcim/inventory-item-templates/: get: operationId: dcim_inventory-item-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: part_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: parent_id in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: role_id in: query description: '' required: false type: string - name: role in: query description: '' required: false type: string - name: component_type in: query description: '' required: false type: string - name: component_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: part_id__n in: query description: '' required: false type: string - name: part_id__ic in: query description: '' required: false type: string - name: part_id__nic in: query description: '' required: false type: string - name: part_id__iew in: query description: '' required: false type: string - name: part_id__niew in: query description: '' required: false type: string - name: part_id__isw in: query description: '' required: false type: string - name: part_id__nisw in: query description: '' required: false type: string - name: part_id__ie in: query description: '' required: false type: string - name: part_id__nie in: query description: '' required: false type: string - name: part_id__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: parent_id__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: role_id__n in: query description: '' required: false type: string - name: role__n in: query description: '' required: false type: string - name: component_type__n in: query description: '' required: false type: string - name: component_id__n in: query description: '' required: false type: string - name: component_id__lte in: query description: '' required: false type: string - name: component_id__lt in: query description: '' required: false type: string - name: component_id__gte in: query description: '' required: false type: string - name: component_id__gt in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim post: operationId: dcim_inventory-item-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItemTemplate' responses: '201': description: '' schema: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim put: operationId: dcim_inventory-item-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItemTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim patch: operationId: dcim_inventory-item-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItemTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim delete: operationId: dcim_inventory-item-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/inventory-item-templates/{id}/: get: operationId: dcim_inventory-item-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim put: operationId: dcim_inventory-item-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItemTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim patch: operationId: dcim_inventory-item-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItemTemplate' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItemTemplate' tags: - dcim delete: operationId: dcim_inventory-item-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this inventory item template. required: true type: integer /dcim/inventory-items/: get: operationId: dcim_inventory-items_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: part_id in: query description: '' required: false type: string - name: asset_tag in: query description: '' required: false type: string - name: discovered in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: parent_id in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: role_id in: query description: '' required: false type: string - name: role in: query description: '' required: false type: string - name: component_type in: query description: '' required: false type: string - name: component_id in: query description: '' required: false type: string - name: serial in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: part_id__n in: query description: '' required: false type: string - name: part_id__ic in: query description: '' required: false type: string - name: part_id__nic in: query description: '' required: false type: string - name: part_id__iew in: query description: '' required: false type: string - name: part_id__niew in: query description: '' required: false type: string - name: part_id__isw in: query description: '' required: false type: string - name: part_id__nisw in: query description: '' required: false type: string - name: part_id__ie in: query description: '' required: false type: string - name: part_id__nie in: query description: '' required: false type: string - name: part_id__empty in: query description: '' required: false type: string - name: asset_tag__n in: query description: '' required: false type: string - name: asset_tag__ic in: query description: '' required: false type: string - name: asset_tag__nic in: query description: '' required: false type: string - name: asset_tag__iew in: query description: '' required: false type: string - name: asset_tag__niew in: query description: '' required: false type: string - name: asset_tag__isw in: query description: '' required: false type: string - name: asset_tag__nisw in: query description: '' required: false type: string - name: asset_tag__ie in: query description: '' required: false type: string - name: asset_tag__nie in: query description: '' required: false type: string - name: asset_tag__empty in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: parent_id__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: role_id__n in: query description: '' required: false type: string - name: role__n in: query description: '' required: false type: string - name: component_type__n in: query description: '' required: false type: string - name: component_id__n in: query description: '' required: false type: string - name: component_id__lte in: query description: '' required: false type: string - name: component_id__lt in: query description: '' required: false type: string - name: component_id__gte in: query description: '' required: false type: string - name: component_id__gt in: query description: '' required: false type: string - name: serial__n in: query description: '' required: false type: string - name: serial__ic in: query description: '' required: false type: string - name: serial__nic in: query description: '' required: false type: string - name: serial__iew in: query description: '' required: false type: string - name: serial__niew in: query description: '' required: false type: string - name: serial__isw in: query description: '' required: false type: string - name: serial__nisw in: query description: '' required: false type: string - name: serial__ie in: query description: '' required: false type: string - name: serial__nie in: query description: '' required: false type: string - name: serial__empty in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/InventoryItem' tags: - dcim post: operationId: dcim_inventory-items_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItem' responses: '201': description: '' schema: $ref: '#/definitions/InventoryItem' tags: - dcim put: operationId: dcim_inventory-items_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItem' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItem' tags: - dcim patch: operationId: dcim_inventory-items_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItem' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItem' tags: - dcim delete: operationId: dcim_inventory-items_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/inventory-items/{id}/: get: operationId: dcim_inventory-items_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/InventoryItem' tags: - dcim put: operationId: dcim_inventory-items_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItem' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItem' tags: - dcim patch: operationId: dcim_inventory-items_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableInventoryItem' responses: '200': description: '' schema: $ref: '#/definitions/InventoryItem' tags: - dcim delete: operationId: dcim_inventory-items_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this inventory item. required: true type: integer /dcim/locations/: get: operationId: dcim_locations_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: parent_id in: query description: '' required: false type: string - name: parent in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: parent_id__n in: query description: '' required: false type: string - name: parent__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Location' tags: - dcim post: operationId: dcim_locations_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableLocation' responses: '201': description: '' schema: $ref: '#/definitions/Location' tags: - dcim put: operationId: dcim_locations_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableLocation' responses: '200': description: '' schema: $ref: '#/definitions/Location' tags: - dcim patch: operationId: dcim_locations_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableLocation' responses: '200': description: '' schema: $ref: '#/definitions/Location' tags: - dcim delete: operationId: dcim_locations_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/locations/{id}/: get: operationId: dcim_locations_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Location' tags: - dcim put: operationId: dcim_locations_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableLocation' responses: '200': description: '' schema: $ref: '#/definitions/Location' tags: - dcim patch: operationId: dcim_locations_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableLocation' responses: '200': description: '' schema: $ref: '#/definitions/Location' tags: - dcim delete: operationId: dcim_locations_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this location. required: true type: integer /dcim/manufacturers/: get: operationId: dcim_manufacturers_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Manufacturer' tags: - dcim post: operationId: dcim_manufacturers_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Manufacturer' responses: '201': description: '' schema: $ref: '#/definitions/Manufacturer' tags: - dcim put: operationId: dcim_manufacturers_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Manufacturer' responses: '200': description: '' schema: $ref: '#/definitions/Manufacturer' tags: - dcim patch: operationId: dcim_manufacturers_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Manufacturer' responses: '200': description: '' schema: $ref: '#/definitions/Manufacturer' tags: - dcim delete: operationId: dcim_manufacturers_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/manufacturers/{id}/: get: operationId: dcim_manufacturers_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Manufacturer' tags: - dcim put: operationId: dcim_manufacturers_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Manufacturer' responses: '200': description: '' schema: $ref: '#/definitions/Manufacturer' tags: - dcim patch: operationId: dcim_manufacturers_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Manufacturer' responses: '200': description: '' schema: $ref: '#/definitions/Manufacturer' tags: - dcim delete: operationId: dcim_manufacturers_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this manufacturer. required: true type: integer /dcim/module-bay-templates/: get: operationId: dcim_module-bay-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim post: operationId: dcim_module-bay-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBayTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim put: operationId: dcim_module-bay-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim patch: operationId: dcim_module-bay-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim delete: operationId: dcim_module-bay-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/module-bay-templates/{id}/: get: operationId: dcim_module-bay-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim put: operationId: dcim_module-bay-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim patch: operationId: dcim_module-bay-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBayTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBayTemplate' tags: - dcim delete: operationId: dcim_module-bay-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this module bay template. required: true type: integer /dcim/module-bays/: get: operationId: dcim_module-bays_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ModuleBay' tags: - dcim post: operationId: dcim_module-bays_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBay' responses: '201': description: '' schema: $ref: '#/definitions/ModuleBay' tags: - dcim put: operationId: dcim_module-bays_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBay' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBay' tags: - dcim patch: operationId: dcim_module-bays_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBay' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBay' tags: - dcim delete: operationId: dcim_module-bays_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/module-bays/{id}/: get: operationId: dcim_module-bays_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ModuleBay' tags: - dcim put: operationId: dcim_module-bays_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBay' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBay' tags: - dcim patch: operationId: dcim_module-bays_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleBay' responses: '200': description: '' schema: $ref: '#/definitions/ModuleBay' tags: - dcim delete: operationId: dcim_module-bays_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this module bay. required: true type: integer /dcim/module-types/: get: operationId: dcim_module-types_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: model in: query description: '' required: false type: string - name: part_number in: query description: '' required: false type: string - name: weight in: query description: '' required: false type: string - name: weight_unit in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: console_ports in: query description: '' required: false type: string - name: console_server_ports in: query description: '' required: false type: string - name: power_ports in: query description: '' required: false type: string - name: power_outlets in: query description: '' required: false type: string - name: interfaces in: query description: '' required: false type: string - name: pass_through_ports in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: model__n in: query description: '' required: false type: string - name: model__ic in: query description: '' required: false type: string - name: model__nic in: query description: '' required: false type: string - name: model__iew in: query description: '' required: false type: string - name: model__niew in: query description: '' required: false type: string - name: model__isw in: query description: '' required: false type: string - name: model__nisw in: query description: '' required: false type: string - name: model__ie in: query description: '' required: false type: string - name: model__nie in: query description: '' required: false type: string - name: model__empty in: query description: '' required: false type: string - name: part_number__n in: query description: '' required: false type: string - name: part_number__ic in: query description: '' required: false type: string - name: part_number__nic in: query description: '' required: false type: string - name: part_number__iew in: query description: '' required: false type: string - name: part_number__niew in: query description: '' required: false type: string - name: part_number__isw in: query description: '' required: false type: string - name: part_number__nisw in: query description: '' required: false type: string - name: part_number__ie in: query description: '' required: false type: string - name: part_number__nie in: query description: '' required: false type: string - name: part_number__empty in: query description: '' required: false type: string - name: weight__n in: query description: '' required: false type: string - name: weight__lte in: query description: '' required: false type: string - name: weight__lt in: query description: '' required: false type: string - name: weight__gte in: query description: '' required: false type: string - name: weight__gt in: query description: '' required: false type: string - name: weight_unit__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ModuleType' tags: - dcim post: operationId: dcim_module-types_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleType' responses: '201': description: '' schema: $ref: '#/definitions/ModuleType' tags: - dcim put: operationId: dcim_module-types_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleType' responses: '200': description: '' schema: $ref: '#/definitions/ModuleType' tags: - dcim patch: operationId: dcim_module-types_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleType' responses: '200': description: '' schema: $ref: '#/definitions/ModuleType' tags: - dcim delete: operationId: dcim_module-types_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/module-types/{id}/: get: operationId: dcim_module-types_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ModuleType' tags: - dcim put: operationId: dcim_module-types_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleType' responses: '200': description: '' schema: $ref: '#/definitions/ModuleType' tags: - dcim patch: operationId: dcim_module-types_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModuleType' responses: '200': description: '' schema: $ref: '#/definitions/ModuleType' tags: - dcim delete: operationId: dcim_module-types_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this module type. required: true type: integer /dcim/modules/: get: operationId: dcim_modules_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: asset_tag in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: module_type_id in: query description: '' required: false type: string - name: module_type in: query description: '' required: false type: string - name: module_bay_id in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: serial in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: asset_tag__n in: query description: '' required: false type: string - name: asset_tag__ic in: query description: '' required: false type: string - name: asset_tag__nic in: query description: '' required: false type: string - name: asset_tag__iew in: query description: '' required: false type: string - name: asset_tag__niew in: query description: '' required: false type: string - name: asset_tag__isw in: query description: '' required: false type: string - name: asset_tag__nisw in: query description: '' required: false type: string - name: asset_tag__ie in: query description: '' required: false type: string - name: asset_tag__nie in: query description: '' required: false type: string - name: asset_tag__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: module_type_id__n in: query description: '' required: false type: string - name: module_type__n in: query description: '' required: false type: string - name: module_bay_id__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: serial__n in: query description: '' required: false type: string - name: serial__ic in: query description: '' required: false type: string - name: serial__nic in: query description: '' required: false type: string - name: serial__iew in: query description: '' required: false type: string - name: serial__niew in: query description: '' required: false type: string - name: serial__isw in: query description: '' required: false type: string - name: serial__nisw in: query description: '' required: false type: string - name: serial__ie in: query description: '' required: false type: string - name: serial__nie in: query description: '' required: false type: string - name: serial__empty in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Module' tags: - dcim post: operationId: dcim_modules_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModule' responses: '201': description: '' schema: $ref: '#/definitions/Module' tags: - dcim put: operationId: dcim_modules_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModule' responses: '200': description: '' schema: $ref: '#/definitions/Module' tags: - dcim patch: operationId: dcim_modules_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModule' responses: '200': description: '' schema: $ref: '#/definitions/Module' tags: - dcim delete: operationId: dcim_modules_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/modules/{id}/: get: operationId: dcim_modules_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Module' tags: - dcim put: operationId: dcim_modules_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModule' responses: '200': description: '' schema: $ref: '#/definitions/Module' tags: - dcim patch: operationId: dcim_modules_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableModule' responses: '200': description: '' schema: $ref: '#/definitions/Module' tags: - dcim delete: operationId: dcim_modules_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this module. required: true type: integer /dcim/platforms/: get: operationId: dcim_platforms_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: manufacturer_id in: query description: '' required: false type: string - name: manufacturer in: query description: '' required: false type: string - name: config_template_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: manufacturer_id__n in: query description: '' required: false type: string - name: manufacturer__n in: query description: '' required: false type: string - name: config_template_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Platform' tags: - dcim post: operationId: dcim_platforms_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePlatform' responses: '201': description: '' schema: $ref: '#/definitions/Platform' tags: - dcim put: operationId: dcim_platforms_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePlatform' responses: '200': description: '' schema: $ref: '#/definitions/Platform' tags: - dcim patch: operationId: dcim_platforms_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePlatform' responses: '200': description: '' schema: $ref: '#/definitions/Platform' tags: - dcim delete: operationId: dcim_platforms_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/platforms/{id}/: get: operationId: dcim_platforms_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Platform' tags: - dcim put: operationId: dcim_platforms_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePlatform' responses: '200': description: '' schema: $ref: '#/definitions/Platform' tags: - dcim patch: operationId: dcim_platforms_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePlatform' responses: '200': description: '' schema: $ref: '#/definitions/Platform' tags: - dcim delete: operationId: dcim_platforms_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this platform. required: true type: integer /dcim/power-feeds/: get: operationId: dcim_power-feeds_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: supply in: query description: '' required: false type: string - name: phase in: query description: '' required: false type: string - name: voltage in: query description: '' required: false type: string - name: amperage in: query description: '' required: false type: string - name: max_utilization in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: connected in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: power_panel_id in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: supply__n in: query description: '' required: false type: string - name: phase__n in: query description: '' required: false type: string - name: voltage__n in: query description: '' required: false type: string - name: voltage__lte in: query description: '' required: false type: string - name: voltage__lt in: query description: '' required: false type: string - name: voltage__gte in: query description: '' required: false type: string - name: voltage__gt in: query description: '' required: false type: string - name: amperage__n in: query description: '' required: false type: string - name: amperage__lte in: query description: '' required: false type: string - name: amperage__lt in: query description: '' required: false type: string - name: amperage__gte in: query description: '' required: false type: string - name: amperage__gt in: query description: '' required: false type: string - name: max_utilization__n in: query description: '' required: false type: string - name: max_utilization__lte in: query description: '' required: false type: string - name: max_utilization__lt in: query description: '' required: false type: string - name: max_utilization__gte in: query description: '' required: false type: string - name: max_utilization__gt in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: power_panel_id__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/PowerFeed' tags: - dcim post: operationId: dcim_power-feeds_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerFeed' responses: '201': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim put: operationId: dcim_power-feeds_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerFeed' responses: '200': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim patch: operationId: dcim_power-feeds_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerFeed' responses: '200': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim delete: operationId: dcim_power-feeds_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/power-feeds/{id}/: get: operationId: dcim_power-feeds_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim put: operationId: dcim_power-feeds_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerFeed' responses: '200': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim patch: operationId: dcim_power-feeds_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerFeed' responses: '200': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim delete: operationId: dcim_power-feeds_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power feed. required: true type: integer /dcim/power-feeds/{id}/trace/: get: operationId: dcim_power-feeds_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerFeed' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power feed. required: true type: integer /dcim/power-outlet-templates/: get: operationId: dcim_power-outlet-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: feed_leg in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: feed_leg__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim post: operationId: dcim_power-outlet-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutletTemplate' responses: '201': description: '' schema: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim put: operationId: dcim_power-outlet-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutletTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim patch: operationId: dcim_power-outlet-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutletTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim delete: operationId: dcim_power-outlet-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/power-outlet-templates/{id}/: get: operationId: dcim_power-outlet-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim put: operationId: dcim_power-outlet-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutletTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim patch: operationId: dcim_power-outlet-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutletTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutletTemplate' tags: - dcim delete: operationId: dcim_power-outlet-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power outlet template. required: true type: integer /dcim/power-outlets/: get: operationId: dcim_power-outlets_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: feed_leg in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: connected in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: feed_leg__n in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/PowerOutlet' tags: - dcim post: operationId: dcim_power-outlets_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutlet' responses: '201': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim put: operationId: dcim_power-outlets_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutlet' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim patch: operationId: dcim_power-outlets_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutlet' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim delete: operationId: dcim_power-outlets_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/power-outlets/{id}/: get: operationId: dcim_power-outlets_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim put: operationId: dcim_power-outlets_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutlet' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim patch: operationId: dcim_power-outlets_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerOutlet' responses: '200': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim delete: operationId: dcim_power-outlets_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power outlet. required: true type: integer /dcim/power-outlets/{id}/trace/: get: operationId: dcim_power-outlets_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerOutlet' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power outlet. required: true type: integer /dcim/power-panels/: get: operationId: dcim_power-panels_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/PowerPanel' tags: - dcim post: operationId: dcim_power-panels_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPanel' responses: '201': description: '' schema: $ref: '#/definitions/PowerPanel' tags: - dcim put: operationId: dcim_power-panels_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPanel' responses: '200': description: '' schema: $ref: '#/definitions/PowerPanel' tags: - dcim patch: operationId: dcim_power-panels_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPanel' responses: '200': description: '' schema: $ref: '#/definitions/PowerPanel' tags: - dcim delete: operationId: dcim_power-panels_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/power-panels/{id}/: get: operationId: dcim_power-panels_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerPanel' tags: - dcim put: operationId: dcim_power-panels_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPanel' responses: '200': description: '' schema: $ref: '#/definitions/PowerPanel' tags: - dcim patch: operationId: dcim_power-panels_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPanel' responses: '200': description: '' schema: $ref: '#/definitions/PowerPanel' tags: - dcim delete: operationId: dcim_power-panels_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power panel. required: true type: integer /dcim/power-port-templates/: get: operationId: dcim_power-port-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: maximum_draw in: query description: '' required: false type: string - name: allocated_draw in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: maximum_draw__n in: query description: '' required: false type: string - name: maximum_draw__lte in: query description: '' required: false type: string - name: maximum_draw__lt in: query description: '' required: false type: string - name: maximum_draw__gte in: query description: '' required: false type: string - name: maximum_draw__gt in: query description: '' required: false type: string - name: allocated_draw__n in: query description: '' required: false type: string - name: allocated_draw__lte in: query description: '' required: false type: string - name: allocated_draw__lt in: query description: '' required: false type: string - name: allocated_draw__gte in: query description: '' required: false type: string - name: allocated_draw__gt in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/PowerPortTemplate' tags: - dcim post: operationId: dcim_power-port-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPortTemplate' responses: '201': description: '' schema: $ref: '#/definitions/PowerPortTemplate' tags: - dcim put: operationId: dcim_power-port-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerPortTemplate' tags: - dcim patch: operationId: dcim_power-port-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerPortTemplate' tags: - dcim delete: operationId: dcim_power-port-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/power-port-templates/{id}/: get: operationId: dcim_power-port-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerPortTemplate' tags: - dcim put: operationId: dcim_power-port-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerPortTemplate' tags: - dcim patch: operationId: dcim_power-port-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/PowerPortTemplate' tags: - dcim delete: operationId: dcim_power-port-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power port template. required: true type: integer /dcim/power-ports/: get: operationId: dcim_power-ports_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: maximum_draw in: query description: '' required: false type: string - name: allocated_draw in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: connected in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: maximum_draw__n in: query description: '' required: false type: string - name: maximum_draw__lte in: query description: '' required: false type: string - name: maximum_draw__lt in: query description: '' required: false type: string - name: maximum_draw__gte in: query description: '' required: false type: string - name: maximum_draw__gt in: query description: '' required: false type: string - name: allocated_draw__n in: query description: '' required: false type: string - name: allocated_draw__lte in: query description: '' required: false type: string - name: allocated_draw__lt in: query description: '' required: false type: string - name: allocated_draw__gte in: query description: '' required: false type: string - name: allocated_draw__gt in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/PowerPort' tags: - dcim post: operationId: dcim_power-ports_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPort' responses: '201': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim put: operationId: dcim_power-ports_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPort' responses: '200': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim patch: operationId: dcim_power-ports_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPort' responses: '200': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim delete: operationId: dcim_power-ports_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/power-ports/{id}/: get: operationId: dcim_power-ports_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim put: operationId: dcim_power-ports_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPort' responses: '200': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim patch: operationId: dcim_power-ports_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritablePowerPort' responses: '200': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim delete: operationId: dcim_power-ports_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power port. required: true type: integer /dcim/power-ports/{id}/trace/: get: operationId: dcim_power-ports_trace description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/PowerPort' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this power port. required: true type: integer /dcim/rack-reservations/: get: operationId: dcim_rack-reservations_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: user_id in: query description: '' required: false type: string - name: user in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: user_id__n in: query description: '' required: false type: string - name: user__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/RackReservation' tags: - dcim post: operationId: dcim_rack-reservations_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRackReservation' responses: '201': description: '' schema: $ref: '#/definitions/RackReservation' tags: - dcim put: operationId: dcim_rack-reservations_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRackReservation' responses: '200': description: '' schema: $ref: '#/definitions/RackReservation' tags: - dcim patch: operationId: dcim_rack-reservations_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRackReservation' responses: '200': description: '' schema: $ref: '#/definitions/RackReservation' tags: - dcim delete: operationId: dcim_rack-reservations_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/rack-reservations/{id}/: get: operationId: dcim_rack-reservations_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/RackReservation' tags: - dcim put: operationId: dcim_rack-reservations_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRackReservation' responses: '200': description: '' schema: $ref: '#/definitions/RackReservation' tags: - dcim patch: operationId: dcim_rack-reservations_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRackReservation' responses: '200': description: '' schema: $ref: '#/definitions/RackReservation' tags: - dcim delete: operationId: dcim_rack-reservations_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rack reservation. required: true type: integer /dcim/rack-roles/: get: operationId: dcim_rack-roles_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/RackRole' tags: - dcim post: operationId: dcim_rack-roles_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/RackRole' responses: '201': description: '' schema: $ref: '#/definitions/RackRole' tags: - dcim put: operationId: dcim_rack-roles_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/RackRole' responses: '200': description: '' schema: $ref: '#/definitions/RackRole' tags: - dcim patch: operationId: dcim_rack-roles_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/RackRole' responses: '200': description: '' schema: $ref: '#/definitions/RackRole' tags: - dcim delete: operationId: dcim_rack-roles_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/rack-roles/{id}/: get: operationId: dcim_rack-roles_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/RackRole' tags: - dcim put: operationId: dcim_rack-roles_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/RackRole' responses: '200': description: '' schema: $ref: '#/definitions/RackRole' tags: - dcim patch: operationId: dcim_rack-roles_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/RackRole' responses: '200': description: '' schema: $ref: '#/definitions/RackRole' tags: - dcim delete: operationId: dcim_rack-roles_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rack role. required: true type: integer /dcim/racks/: get: operationId: dcim_racks_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: facility_id in: query description: '' required: false type: string - name: asset_tag in: query description: '' required: false type: string - name: u_height in: query description: '' required: false type: string - name: desc_units in: query description: '' required: false type: string - name: outer_width in: query description: '' required: false type: string - name: outer_depth in: query description: '' required: false type: string - name: outer_unit in: query description: '' required: false type: string - name: mounting_depth in: query description: '' required: false type: string - name: weight in: query description: '' required: false type: string - name: max_weight in: query description: '' required: false type: string - name: weight_unit in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: width in: query description: '' required: false type: string - name: role_id in: query description: '' required: false type: string - name: role in: query description: '' required: false type: string - name: serial in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: facility_id__n in: query description: '' required: false type: string - name: facility_id__ic in: query description: '' required: false type: string - name: facility_id__nic in: query description: '' required: false type: string - name: facility_id__iew in: query description: '' required: false type: string - name: facility_id__niew in: query description: '' required: false type: string - name: facility_id__isw in: query description: '' required: false type: string - name: facility_id__nisw in: query description: '' required: false type: string - name: facility_id__ie in: query description: '' required: false type: string - name: facility_id__nie in: query description: '' required: false type: string - name: facility_id__empty in: query description: '' required: false type: string - name: asset_tag__n in: query description: '' required: false type: string - name: asset_tag__ic in: query description: '' required: false type: string - name: asset_tag__nic in: query description: '' required: false type: string - name: asset_tag__iew in: query description: '' required: false type: string - name: asset_tag__niew in: query description: '' required: false type: string - name: asset_tag__isw in: query description: '' required: false type: string - name: asset_tag__nisw in: query description: '' required: false type: string - name: asset_tag__ie in: query description: '' required: false type: string - name: asset_tag__nie in: query description: '' required: false type: string - name: asset_tag__empty in: query description: '' required: false type: string - name: u_height__n in: query description: '' required: false type: string - name: u_height__lte in: query description: '' required: false type: string - name: u_height__lt in: query description: '' required: false type: string - name: u_height__gte in: query description: '' required: false type: string - name: u_height__gt in: query description: '' required: false type: string - name: outer_width__n in: query description: '' required: false type: string - name: outer_width__lte in: query description: '' required: false type: string - name: outer_width__lt in: query description: '' required: false type: string - name: outer_width__gte in: query description: '' required: false type: string - name: outer_width__gt in: query description: '' required: false type: string - name: outer_depth__n in: query description: '' required: false type: string - name: outer_depth__lte in: query description: '' required: false type: string - name: outer_depth__lt in: query description: '' required: false type: string - name: outer_depth__gte in: query description: '' required: false type: string - name: outer_depth__gt in: query description: '' required: false type: string - name: outer_unit__n in: query description: '' required: false type: string - name: mounting_depth__n in: query description: '' required: false type: string - name: mounting_depth__lte in: query description: '' required: false type: string - name: mounting_depth__lt in: query description: '' required: false type: string - name: mounting_depth__gte in: query description: '' required: false type: string - name: mounting_depth__gt in: query description: '' required: false type: string - name: weight__n in: query description: '' required: false type: string - name: weight__lte in: query description: '' required: false type: string - name: weight__lt in: query description: '' required: false type: string - name: weight__gte in: query description: '' required: false type: string - name: weight__gt in: query description: '' required: false type: string - name: max_weight__n in: query description: '' required: false type: string - name: max_weight__lte in: query description: '' required: false type: string - name: max_weight__lt in: query description: '' required: false type: string - name: max_weight__gte in: query description: '' required: false type: string - name: max_weight__gt in: query description: '' required: false type: string - name: weight_unit__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: width__n in: query description: '' required: false type: string - name: role_id__n in: query description: '' required: false type: string - name: role__n in: query description: '' required: false type: string - name: serial__n in: query description: '' required: false type: string - name: serial__ic in: query description: '' required: false type: string - name: serial__nic in: query description: '' required: false type: string - name: serial__iew in: query description: '' required: false type: string - name: serial__niew in: query description: '' required: false type: string - name: serial__isw in: query description: '' required: false type: string - name: serial__nisw in: query description: '' required: false type: string - name: serial__ie in: query description: '' required: false type: string - name: serial__nie in: query description: '' required: false type: string - name: serial__empty in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Rack' tags: - dcim post: operationId: dcim_racks_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRack' responses: '201': description: '' schema: $ref: '#/definitions/Rack' tags: - dcim put: operationId: dcim_racks_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRack' responses: '200': description: '' schema: $ref: '#/definitions/Rack' tags: - dcim patch: operationId: dcim_racks_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRack' responses: '200': description: '' schema: $ref: '#/definitions/Rack' tags: - dcim delete: operationId: dcim_racks_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/racks/{id}/: get: operationId: dcim_racks_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Rack' tags: - dcim put: operationId: dcim_racks_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRack' responses: '200': description: '' schema: $ref: '#/definitions/Rack' tags: - dcim patch: operationId: dcim_racks_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRack' responses: '200': description: '' schema: $ref: '#/definitions/Rack' tags: - dcim delete: operationId: dcim_racks_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rack. required: true type: integer /dcim/racks/{id}/elevation/: get: operationId: dcim_racks_elevation description: Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG. parameters: - name: q in: query required: false type: string minLength: 1 - name: face in: query required: false type: string enum: - front - rear default: front - name: render in: query required: false type: string enum: - json - svg default: json - name: unit_width in: query required: false type: integer default: 220 - name: unit_height in: query required: false type: integer default: 22 - name: legend_width in: query required: false type: integer default: 30 - name: margin_width in: query required: false type: integer default: 15 - name: exclude in: query required: false type: integer - name: expand_devices in: query required: false type: boolean default: true - name: include_images in: query required: false type: boolean default: true responses: '200': description: '' schema: type: array items: $ref: '#/definitions/RackUnit' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rack. required: true type: integer /dcim/rear-port-templates/: get: operationId: dcim_rear-port-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: positions in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: devicetype_id in: query description: '' required: false type: string - name: moduletype_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: positions__n in: query description: '' required: false type: string - name: positions__lte in: query description: '' required: false type: string - name: positions__lt in: query description: '' required: false type: string - name: positions__gte in: query description: '' required: false type: string - name: positions__gt in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: devicetype_id__n in: query description: '' required: false type: string - name: moduletype_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/RearPortTemplate' tags: - dcim post: operationId: dcim_rear-port-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPortTemplate' responses: '201': description: '' schema: $ref: '#/definitions/RearPortTemplate' tags: - dcim put: operationId: dcim_rear-port-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/RearPortTemplate' tags: - dcim patch: operationId: dcim_rear-port-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/RearPortTemplate' tags: - dcim delete: operationId: dcim_rear-port-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/rear-port-templates/{id}/: get: operationId: dcim_rear-port-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/RearPortTemplate' tags: - dcim put: operationId: dcim_rear-port-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/RearPortTemplate' tags: - dcim patch: operationId: dcim_rear-port-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPortTemplate' responses: '200': description: '' schema: $ref: '#/definitions/RearPortTemplate' tags: - dcim delete: operationId: dcim_rear-port-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rear port template. required: true type: integer /dcim/rear-ports/: get: operationId: dcim_rear-ports_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: label in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: color in: query description: '' required: false type: string - name: positions in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: cable_end in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: rack_id in: query description: '' required: false type: string - name: rack in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: virtual_chassis_id in: query description: '' required: false type: string - name: virtual_chassis in: query description: '' required: false type: string - name: module_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: cabled in: query description: '' required: false type: string - name: occupied in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: label__n in: query description: '' required: false type: string - name: label__ic in: query description: '' required: false type: string - name: label__nic in: query description: '' required: false type: string - name: label__iew in: query description: '' required: false type: string - name: label__niew in: query description: '' required: false type: string - name: label__isw in: query description: '' required: false type: string - name: label__nisw in: query description: '' required: false type: string - name: label__ie in: query description: '' required: false type: string - name: label__nie in: query description: '' required: false type: string - name: label__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: color__n in: query description: '' required: false type: string - name: color__ic in: query description: '' required: false type: string - name: color__nic in: query description: '' required: false type: string - name: color__iew in: query description: '' required: false type: string - name: color__niew in: query description: '' required: false type: string - name: color__isw in: query description: '' required: false type: string - name: color__nisw in: query description: '' required: false type: string - name: color__ie in: query description: '' required: false type: string - name: color__nie in: query description: '' required: false type: string - name: color__empty in: query description: '' required: false type: string - name: positions__n in: query description: '' required: false type: string - name: positions__lte in: query description: '' required: false type: string - name: positions__lt in: query description: '' required: false type: string - name: positions__gte in: query description: '' required: false type: string - name: positions__gt in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: cable_end__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: rack_id__n in: query description: '' required: false type: string - name: rack__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: virtual_chassis_id__n in: query description: '' required: false type: string - name: virtual_chassis__n in: query description: '' required: false type: string - name: module_id__n in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/RearPort' tags: - dcim post: operationId: dcim_rear-ports_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPort' responses: '201': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim put: operationId: dcim_rear-ports_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPort' responses: '200': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim patch: operationId: dcim_rear-ports_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPort' responses: '200': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim delete: operationId: dcim_rear-ports_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/rear-ports/{id}/: get: operationId: dcim_rear-ports_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim put: operationId: dcim_rear-ports_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPort' responses: '200': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim patch: operationId: dcim_rear-ports_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRearPort' responses: '200': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim delete: operationId: dcim_rear-ports_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rear port. required: true type: integer /dcim/rear-ports/{id}/paths/: get: operationId: dcim_rear-ports_paths description: Return all CablePaths which traverse a given pass-through port. parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/RearPort' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this rear port. required: true type: integer /dcim/regions/: get: operationId: dcim_regions_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: parent_id in: query description: '' required: false type: string - name: parent in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: parent_id__n in: query description: '' required: false type: string - name: parent__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Region' tags: - dcim post: operationId: dcim_regions_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRegion' responses: '201': description: '' schema: $ref: '#/definitions/Region' tags: - dcim put: operationId: dcim_regions_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRegion' responses: '200': description: '' schema: $ref: '#/definitions/Region' tags: - dcim patch: operationId: dcim_regions_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRegion' responses: '200': description: '' schema: $ref: '#/definitions/Region' tags: - dcim delete: operationId: dcim_regions_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/regions/{id}/: get: operationId: dcim_regions_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Region' tags: - dcim put: operationId: dcim_regions_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRegion' responses: '200': description: '' schema: $ref: '#/definitions/Region' tags: - dcim patch: operationId: dcim_regions_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableRegion' responses: '200': description: '' schema: $ref: '#/definitions/Region' tags: - dcim delete: operationId: dcim_regions_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this region. required: true type: integer /dcim/site-groups/: get: operationId: dcim_site-groups_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: parent_id in: query description: '' required: false type: string - name: parent in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: parent_id__n in: query description: '' required: false type: string - name: parent__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/SiteGroup' tags: - dcim post: operationId: dcim_site-groups_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSiteGroup' responses: '201': description: '' schema: $ref: '#/definitions/SiteGroup' tags: - dcim put: operationId: dcim_site-groups_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSiteGroup' responses: '200': description: '' schema: $ref: '#/definitions/SiteGroup' tags: - dcim patch: operationId: dcim_site-groups_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSiteGroup' responses: '200': description: '' schema: $ref: '#/definitions/SiteGroup' tags: - dcim delete: operationId: dcim_site-groups_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/site-groups/{id}/: get: operationId: dcim_site-groups_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/SiteGroup' tags: - dcim put: operationId: dcim_site-groups_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSiteGroup' responses: '200': description: '' schema: $ref: '#/definitions/SiteGroup' tags: - dcim patch: operationId: dcim_site-groups_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSiteGroup' responses: '200': description: '' schema: $ref: '#/definitions/SiteGroup' tags: - dcim delete: operationId: dcim_site-groups_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this site group. required: true type: integer /dcim/sites/: get: operationId: dcim_sites_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: slug in: query description: '' required: false type: string - name: facility in: query description: '' required: false type: string - name: latitude in: query description: '' required: false type: string - name: longitude in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: contact in: query description: '' required: false type: string - name: contact_role in: query description: '' required: false type: string - name: contact_group in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: group_id in: query description: '' required: false type: string - name: group in: query description: '' required: false type: string - name: asn in: query description: '' required: false type: string - name: asn_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: slug__n in: query description: '' required: false type: string - name: slug__ic in: query description: '' required: false type: string - name: slug__nic in: query description: '' required: false type: string - name: slug__iew in: query description: '' required: false type: string - name: slug__niew in: query description: '' required: false type: string - name: slug__isw in: query description: '' required: false type: string - name: slug__nisw in: query description: '' required: false type: string - name: slug__ie in: query description: '' required: false type: string - name: slug__nie in: query description: '' required: false type: string - name: slug__empty in: query description: '' required: false type: string - name: facility__n in: query description: '' required: false type: string - name: facility__ic in: query description: '' required: false type: string - name: facility__nic in: query description: '' required: false type: string - name: facility__iew in: query description: '' required: false type: string - name: facility__niew in: query description: '' required: false type: string - name: facility__isw in: query description: '' required: false type: string - name: facility__nisw in: query description: '' required: false type: string - name: facility__ie in: query description: '' required: false type: string - name: facility__nie in: query description: '' required: false type: string - name: facility__empty in: query description: '' required: false type: string - name: latitude__n in: query description: '' required: false type: string - name: latitude__lte in: query description: '' required: false type: string - name: latitude__lt in: query description: '' required: false type: string - name: latitude__gte in: query description: '' required: false type: string - name: latitude__gt in: query description: '' required: false type: string - name: longitude__n in: query description: '' required: false type: string - name: longitude__lte in: query description: '' required: false type: string - name: longitude__lt in: query description: '' required: false type: string - name: longitude__gte in: query description: '' required: false type: string - name: longitude__gt in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: contact__n in: query description: '' required: false type: string - name: contact_role__n in: query description: '' required: false type: string - name: contact_group__n in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: group_id__n in: query description: '' required: false type: string - name: group__n in: query description: '' required: false type: string - name: asn__n in: query description: '' required: false type: string - name: asn_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/Site' tags: - dcim post: operationId: dcim_sites_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSite' responses: '201': description: '' schema: $ref: '#/definitions/Site' tags: - dcim put: operationId: dcim_sites_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSite' responses: '200': description: '' schema: $ref: '#/definitions/Site' tags: - dcim patch: operationId: dcim_sites_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSite' responses: '200': description: '' schema: $ref: '#/definitions/Site' tags: - dcim delete: operationId: dcim_sites_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/sites/{id}/: get: operationId: dcim_sites_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Site' tags: - dcim put: operationId: dcim_sites_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSite' responses: '200': description: '' schema: $ref: '#/definitions/Site' tags: - dcim patch: operationId: dcim_sites_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableSite' responses: '200': description: '' schema: $ref: '#/definitions/Site' tags: - dcim delete: operationId: dcim_sites_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this site. required: true type: integer /dcim/virtual-chassis/: get: operationId: dcim_virtual-chassis_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: domain in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: master_id in: query description: '' required: false type: string - name: master in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: domain__n in: query description: '' required: false type: string - name: domain__ic in: query description: '' required: false type: string - name: domain__nic in: query description: '' required: false type: string - name: domain__iew in: query description: '' required: false type: string - name: domain__niew in: query description: '' required: false type: string - name: domain__isw in: query description: '' required: false type: string - name: domain__nisw in: query description: '' required: false type: string - name: domain__ie in: query description: '' required: false type: string - name: domain__nie in: query description: '' required: false type: string - name: domain__empty in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: master_id__n in: query description: '' required: false type: string - name: master__n in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/VirtualChassis' tags: - dcim post: operationId: dcim_virtual-chassis_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualChassis' responses: '201': description: '' schema: $ref: '#/definitions/VirtualChassis' tags: - dcim put: operationId: dcim_virtual-chassis_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualChassis' responses: '200': description: '' schema: $ref: '#/definitions/VirtualChassis' tags: - dcim patch: operationId: dcim_virtual-chassis_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualChassis' responses: '200': description: '' schema: $ref: '#/definitions/VirtualChassis' tags: - dcim delete: operationId: dcim_virtual-chassis_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/virtual-chassis/{id}/: get: operationId: dcim_virtual-chassis_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/VirtualChassis' tags: - dcim put: operationId: dcim_virtual-chassis_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualChassis' responses: '200': description: '' schema: $ref: '#/definitions/VirtualChassis' tags: - dcim patch: operationId: dcim_virtual-chassis_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualChassis' responses: '200': description: '' schema: $ref: '#/definitions/VirtualChassis' tags: - dcim delete: operationId: dcim_virtual-chassis_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this virtual chassis. required: true type: integer /dcim/virtual-device-contexts/: get: operationId: dcim_virtual-device-contexts_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: device in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: device_id in: query description: '' required: false type: string - name: status in: query description: '' required: false type: string - name: has_primary_ip in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: device__n in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: device_id__n in: query description: '' required: false type: string - name: status__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim post: operationId: dcim_virtual-device-contexts_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualDeviceContext' responses: '201': description: '' schema: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim put: operationId: dcim_virtual-device-contexts_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualDeviceContext' responses: '200': description: '' schema: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim patch: operationId: dcim_virtual-device-contexts_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualDeviceContext' responses: '200': description: '' schema: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim delete: operationId: dcim_virtual-device-contexts_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: [] /dcim/virtual-device-contexts/{id}/: get: operationId: dcim_virtual-device-contexts_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim put: operationId: dcim_virtual-device-contexts_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualDeviceContext' responses: '200': description: '' schema: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim patch: operationId: dcim_virtual-device-contexts_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableVirtualDeviceContext' responses: '200': description: '' schema: $ref: '#/definitions/VirtualDeviceContext' tags: - dcim delete: operationId: dcim_virtual-device-contexts_delete description: '' parameters: [] responses: '204': description: '' tags: - dcim parameters: - name: id in: path description: A unique integer value identifying this virtual device context. required: true type: integer /extras/config-contexts/: get: operationId: extras_config-contexts_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: is_active in: query description: '' required: false type: string - name: data_synced in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: region_id in: query description: '' required: false type: string - name: region in: query description: '' required: false type: string - name: site_group in: query description: '' required: false type: string - name: site_group_id in: query description: '' required: false type: string - name: site_id in: query description: '' required: false type: string - name: site in: query description: '' required: false type: string - name: location_id in: query description: '' required: false type: string - name: location in: query description: '' required: false type: string - name: device_type_id in: query description: '' required: false type: string - name: role_id in: query description: '' required: false type: string - name: role in: query description: '' required: false type: string - name: platform_id in: query description: '' required: false type: string - name: platform in: query description: '' required: false type: string - name: cluster_type_id in: query description: '' required: false type: string - name: cluster_type in: query description: '' required: false type: string - name: cluster_group_id in: query description: '' required: false type: string - name: cluster_group in: query description: '' required: false type: string - name: cluster_id in: query description: '' required: false type: string - name: tenant_group_id in: query description: '' required: false type: string - name: tenant_group in: query description: '' required: false type: string - name: tenant_id in: query description: '' required: false type: string - name: tenant in: query description: '' required: false type: string - name: tag_id in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: data_source_id in: query description: '' required: false type: string - name: data_file_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: data_synced__n in: query description: '' required: false type: string - name: data_synced__lte in: query description: '' required: false type: string - name: data_synced__lt in: query description: '' required: false type: string - name: data_synced__gte in: query description: '' required: false type: string - name: data_synced__gt in: query description: '' required: false type: string - name: created__n in: query description: '' required: false type: string - name: created__lte in: query description: '' required: false type: string - name: created__lt in: query description: '' required: false type: string - name: created__gte in: query description: '' required: false type: string - name: created__gt in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: region_id__n in: query description: '' required: false type: string - name: region__n in: query description: '' required: false type: string - name: site_group__n in: query description: '' required: false type: string - name: site_group_id__n in: query description: '' required: false type: string - name: site_id__n in: query description: '' required: false type: string - name: site__n in: query description: '' required: false type: string - name: location_id__n in: query description: '' required: false type: string - name: location__n in: query description: '' required: false type: string - name: device_type_id__n in: query description: '' required: false type: string - name: role_id__n in: query description: '' required: false type: string - name: role__n in: query description: '' required: false type: string - name: platform_id__n in: query description: '' required: false type: string - name: platform__n in: query description: '' required: false type: string - name: cluster_type_id__n in: query description: '' required: false type: string - name: cluster_type__n in: query description: '' required: false type: string - name: cluster_group_id__n in: query description: '' required: false type: string - name: cluster_group__n in: query description: '' required: false type: string - name: cluster_id__n in: query description: '' required: false type: string - name: tenant_group_id__n in: query description: '' required: false type: string - name: tenant_group__n in: query description: '' required: false type: string - name: tenant_id__n in: query description: '' required: false type: string - name: tenant__n in: query description: '' required: false type: string - name: tag_id__n in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: data_source_id__n in: query description: '' required: false type: string - name: data_file_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ConfigContext' tags: - extras post: operationId: extras_config-contexts_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigContext' responses: '201': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras put: operationId: extras_config-contexts_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigContext' responses: '200': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras patch: operationId: extras_config-contexts_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigContext' responses: '200': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras delete: operationId: extras_config-contexts_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/config-contexts/{id}/: get: operationId: extras_config-contexts_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras put: operationId: extras_config-contexts_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigContext' responses: '200': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras patch: operationId: extras_config-contexts_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigContext' responses: '200': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras delete: operationId: extras_config-contexts_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this config context. required: true type: integer /extras/config-contexts/{id}/sync/: post: operationId: extras_config-contexts_sync description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigContext' responses: '201': description: '' schema: $ref: '#/definitions/ConfigContext' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this config context. required: true type: integer /extras/config-templates/: get: operationId: extras_config-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: data_synced in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: data_source_id in: query description: '' required: false type: string - name: data_file_id in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: data_synced__n in: query description: '' required: false type: string - name: data_synced__lte in: query description: '' required: false type: string - name: data_synced__lt in: query description: '' required: false type: string - name: data_synced__gte in: query description: '' required: false type: string - name: data_synced__gt in: query description: '' required: false type: string - name: data_source_id__n in: query description: '' required: false type: string - name: data_file_id__n in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ConfigTemplate' tags: - extras post: operationId: extras_config-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras put: operationId: extras_config-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras patch: operationId: extras_config-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras delete: operationId: extras_config-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/config-templates/{id}/: get: operationId: extras_config-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras put: operationId: extras_config-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras patch: operationId: extras_config-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras delete: operationId: extras_config-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this config template. required: true type: integer /extras/config-templates/{id}/render/: post: operationId: extras_config-templates_render description: |- Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data, return the raw rendered content, rather than serialized JSON. parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ConfigTemplate' produces: - application/json - text/plain tags: - extras parameters: - name: id in: path description: A unique integer value identifying this config template. required: true type: integer /extras/config-templates/{id}/sync/: post: operationId: extras_config-templates_sync description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableConfigTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ConfigTemplate' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this config template. required: true type: integer /extras/content-types/: get: operationId: extras_content-types_list description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects. parameters: - name: id in: query description: '' required: false type: number - name: app_label in: query description: '' required: false type: string - name: model in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ContentType' tags: - extras parameters: [] /extras/content-types/{id}/: get: operationId: extras_content-types_read description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects. parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ContentType' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this content type. required: true type: integer /extras/custom-fields/: get: operationId: extras_custom-fields_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: content_types in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: group_name in: query description: '' required: false type: string - name: required in: query description: '' required: false type: string - name: search_weight in: query description: '' required: false type: string - name: filter_logic in: query description: '' required: false type: string - name: ui_visibility in: query description: '' required: false type: string - name: weight in: query description: '' required: false type: string - name: is_cloneable in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: type in: query description: '' required: false type: string - name: content_type_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: content_types__n in: query description: '' required: false type: string - name: content_types__ic in: query description: '' required: false type: string - name: content_types__nic in: query description: '' required: false type: string - name: content_types__iew in: query description: '' required: false type: string - name: content_types__niew in: query description: '' required: false type: string - name: content_types__isw in: query description: '' required: false type: string - name: content_types__nisw in: query description: '' required: false type: string - name: content_types__ie in: query description: '' required: false type: string - name: content_types__nie in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: group_name__n in: query description: '' required: false type: string - name: group_name__ic in: query description: '' required: false type: string - name: group_name__nic in: query description: '' required: false type: string - name: group_name__iew in: query description: '' required: false type: string - name: group_name__niew in: query description: '' required: false type: string - name: group_name__isw in: query description: '' required: false type: string - name: group_name__nisw in: query description: '' required: false type: string - name: group_name__ie in: query description: '' required: false type: string - name: group_name__nie in: query description: '' required: false type: string - name: group_name__empty in: query description: '' required: false type: string - name: search_weight__n in: query description: '' required: false type: string - name: search_weight__lte in: query description: '' required: false type: string - name: search_weight__lt in: query description: '' required: false type: string - name: search_weight__gte in: query description: '' required: false type: string - name: search_weight__gt in: query description: '' required: false type: string - name: filter_logic__n in: query description: '' required: false type: string - name: ui_visibility__n in: query description: '' required: false type: string - name: weight__n in: query description: '' required: false type: string - name: weight__lte in: query description: '' required: false type: string - name: weight__lt in: query description: '' required: false type: string - name: weight__gte in: query description: '' required: false type: string - name: weight__gt in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: type__n in: query description: '' required: false type: string - name: content_type_id__n in: query description: '' required: false type: string - name: content_type_id__lte in: query description: '' required: false type: string - name: content_type_id__lt in: query description: '' required: false type: string - name: content_type_id__gte in: query description: '' required: false type: string - name: content_type_id__gt in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/CustomField' tags: - extras post: operationId: extras_custom-fields_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCustomField' responses: '201': description: '' schema: $ref: '#/definitions/CustomField' tags: - extras put: operationId: extras_custom-fields_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCustomField' responses: '200': description: '' schema: $ref: '#/definitions/CustomField' tags: - extras patch: operationId: extras_custom-fields_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCustomField' responses: '200': description: '' schema: $ref: '#/definitions/CustomField' tags: - extras delete: operationId: extras_custom-fields_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/custom-fields/{id}/: get: operationId: extras_custom-fields_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/CustomField' tags: - extras put: operationId: extras_custom-fields_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCustomField' responses: '200': description: '' schema: $ref: '#/definitions/CustomField' tags: - extras patch: operationId: extras_custom-fields_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableCustomField' responses: '200': description: '' schema: $ref: '#/definitions/CustomField' tags: - extras delete: operationId: extras_custom-fields_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this custom field. required: true type: integer /extras/custom-links/: get: operationId: extras_custom-links_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: content_types in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: enabled in: query description: '' required: false type: string - name: link_text in: query description: '' required: false type: string - name: link_url in: query description: '' required: false type: string - name: weight in: query description: '' required: false type: string - name: group_name in: query description: '' required: false type: string - name: new_window in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: content_type_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: content_types__n in: query description: '' required: false type: string - name: content_types__ic in: query description: '' required: false type: string - name: content_types__nic in: query description: '' required: false type: string - name: content_types__iew in: query description: '' required: false type: string - name: content_types__niew in: query description: '' required: false type: string - name: content_types__isw in: query description: '' required: false type: string - name: content_types__nisw in: query description: '' required: false type: string - name: content_types__ie in: query description: '' required: false type: string - name: content_types__nie in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: link_text__n in: query description: '' required: false type: string - name: link_text__ic in: query description: '' required: false type: string - name: link_text__nic in: query description: '' required: false type: string - name: link_text__iew in: query description: '' required: false type: string - name: link_text__niew in: query description: '' required: false type: string - name: link_text__isw in: query description: '' required: false type: string - name: link_text__nisw in: query description: '' required: false type: string - name: link_text__ie in: query description: '' required: false type: string - name: link_text__nie in: query description: '' required: false type: string - name: link_url__n in: query description: '' required: false type: string - name: link_url__ic in: query description: '' required: false type: string - name: link_url__nic in: query description: '' required: false type: string - name: link_url__iew in: query description: '' required: false type: string - name: link_url__niew in: query description: '' required: false type: string - name: link_url__isw in: query description: '' required: false type: string - name: link_url__nisw in: query description: '' required: false type: string - name: link_url__ie in: query description: '' required: false type: string - name: link_url__nie in: query description: '' required: false type: string - name: weight__n in: query description: '' required: false type: string - name: weight__lte in: query description: '' required: false type: string - name: weight__lt in: query description: '' required: false type: string - name: weight__gte in: query description: '' required: false type: string - name: weight__gt in: query description: '' required: false type: string - name: group_name__n in: query description: '' required: false type: string - name: group_name__ic in: query description: '' required: false type: string - name: group_name__nic in: query description: '' required: false type: string - name: group_name__iew in: query description: '' required: false type: string - name: group_name__niew in: query description: '' required: false type: string - name: group_name__isw in: query description: '' required: false type: string - name: group_name__nisw in: query description: '' required: false type: string - name: group_name__ie in: query description: '' required: false type: string - name: group_name__nie in: query description: '' required: false type: string - name: group_name__empty in: query description: '' required: false type: string - name: content_type_id__n in: query description: '' required: false type: string - name: content_type_id__lte in: query description: '' required: false type: string - name: content_type_id__lt in: query description: '' required: false type: string - name: content_type_id__gte in: query description: '' required: false type: string - name: content_type_id__gt in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/CustomLink' tags: - extras post: operationId: extras_custom-links_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CustomLink' responses: '201': description: '' schema: $ref: '#/definitions/CustomLink' tags: - extras put: operationId: extras_custom-links_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CustomLink' responses: '200': description: '' schema: $ref: '#/definitions/CustomLink' tags: - extras patch: operationId: extras_custom-links_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CustomLink' responses: '200': description: '' schema: $ref: '#/definitions/CustomLink' tags: - extras delete: operationId: extras_custom-links_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/custom-links/{id}/: get: operationId: extras_custom-links_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/CustomLink' tags: - extras put: operationId: extras_custom-links_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CustomLink' responses: '200': description: '' schema: $ref: '#/definitions/CustomLink' tags: - extras patch: operationId: extras_custom-links_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/CustomLink' responses: '200': description: '' schema: $ref: '#/definitions/CustomLink' tags: - extras delete: operationId: extras_custom-links_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this custom link. required: true type: integer /extras/dashboard/: get: operationId: extras_dashboard_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/Dashboard' tags: - extras put: operationId: extras_dashboard_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Dashboard' responses: '200': description: '' schema: $ref: '#/definitions/Dashboard' tags: - extras patch: operationId: extras_dashboard_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/Dashboard' responses: '200': description: '' schema: $ref: '#/definitions/Dashboard' tags: - extras delete: operationId: extras_dashboard_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/export-templates/: get: operationId: extras_export-templates_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: content_types in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: description in: query description: '' required: false type: string - name: data_synced in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: content_type_id in: query description: '' required: false type: string - name: data_source_id in: query description: '' required: false type: string - name: data_file_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: content_types__n in: query description: '' required: false type: string - name: content_types__ic in: query description: '' required: false type: string - name: content_types__nic in: query description: '' required: false type: string - name: content_types__iew in: query description: '' required: false type: string - name: content_types__niew in: query description: '' required: false type: string - name: content_types__isw in: query description: '' required: false type: string - name: content_types__nisw in: query description: '' required: false type: string - name: content_types__ie in: query description: '' required: false type: string - name: content_types__nie in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: description__n in: query description: '' required: false type: string - name: description__ic in: query description: '' required: false type: string - name: description__nic in: query description: '' required: false type: string - name: description__iew in: query description: '' required: false type: string - name: description__niew in: query description: '' required: false type: string - name: description__isw in: query description: '' required: false type: string - name: description__nisw in: query description: '' required: false type: string - name: description__ie in: query description: '' required: false type: string - name: description__nie in: query description: '' required: false type: string - name: description__empty in: query description: '' required: false type: string - name: data_synced__n in: query description: '' required: false type: string - name: data_synced__lte in: query description: '' required: false type: string - name: data_synced__lt in: query description: '' required: false type: string - name: data_synced__gte in: query description: '' required: false type: string - name: data_synced__gt in: query description: '' required: false type: string - name: content_type_id__n in: query description: '' required: false type: string - name: content_type_id__lte in: query description: '' required: false type: string - name: content_type_id__lt in: query description: '' required: false type: string - name: content_type_id__gte in: query description: '' required: false type: string - name: content_type_id__gt in: query description: '' required: false type: string - name: data_source_id__n in: query description: '' required: false type: string - name: data_file_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ExportTemplate' tags: - extras post: operationId: extras_export-templates_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableExportTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras put: operationId: extras_export-templates_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableExportTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras patch: operationId: extras_export-templates_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableExportTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras delete: operationId: extras_export-templates_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/export-templates/{id}/: get: operationId: extras_export-templates_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras put: operationId: extras_export-templates_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableExportTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras patch: operationId: extras_export-templates_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableExportTemplate' responses: '200': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras delete: operationId: extras_export-templates_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this export template. required: true type: integer /extras/export-templates/{id}/sync/: post: operationId: extras_export-templates_sync description: Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any). parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableExportTemplate' responses: '201': description: '' schema: $ref: '#/definitions/ExportTemplate' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this export template. required: true type: integer /extras/image-attachments/: get: operationId: extras_image-attachments_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: content_type_id in: query description: '' required: false type: string - name: object_id in: query description: '' required: false type: string - name: name in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: content_type in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: content_type_id__n in: query description: '' required: false type: string - name: object_id__n in: query description: '' required: false type: string - name: object_id__lte in: query description: '' required: false type: string - name: object_id__lt in: query description: '' required: false type: string - name: object_id__gte in: query description: '' required: false type: string - name: object_id__gt in: query description: '' required: false type: string - name: name__n in: query description: '' required: false type: string - name: name__ic in: query description: '' required: false type: string - name: name__nic in: query description: '' required: false type: string - name: name__iew in: query description: '' required: false type: string - name: name__niew in: query description: '' required: false type: string - name: name__isw in: query description: '' required: false type: string - name: name__nisw in: query description: '' required: false type: string - name: name__ie in: query description: '' required: false type: string - name: name__nie in: query description: '' required: false type: string - name: name__empty in: query description: '' required: false type: string - name: content_type__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ImageAttachment' tags: - extras post: operationId: extras_image-attachments_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/ImageAttachment' responses: '201': description: '' schema: $ref: '#/definitions/ImageAttachment' tags: - extras put: operationId: extras_image-attachments_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/ImageAttachment' responses: '200': description: '' schema: $ref: '#/definitions/ImageAttachment' tags: - extras patch: operationId: extras_image-attachments_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/ImageAttachment' responses: '200': description: '' schema: $ref: '#/definitions/ImageAttachment' tags: - extras delete: operationId: extras_image-attachments_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/image-attachments/{id}/: get: operationId: extras_image-attachments_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ImageAttachment' tags: - extras put: operationId: extras_image-attachments_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/ImageAttachment' responses: '200': description: '' schema: $ref: '#/definitions/ImageAttachment' tags: - extras patch: operationId: extras_image-attachments_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/ImageAttachment' responses: '200': description: '' schema: $ref: '#/definitions/ImageAttachment' tags: - extras delete: operationId: extras_image-attachments_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this image attachment. required: true type: integer /extras/journal-entries/: get: operationId: extras_journal-entries_list description: '' parameters: - name: id in: query description: '' required: false type: string - name: assigned_object_type_id in: query description: '' required: false type: string - name: assigned_object_id in: query description: '' required: false type: string - name: created in: query description: '' required: false type: string - name: kind in: query description: '' required: false type: string - name: last_updated in: query description: '' required: false type: string - name: created_by_request in: query description: '' required: false type: string - name: updated_by_request in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: tag in: query description: '' required: false type: string - name: assigned_object_type in: query description: '' required: false type: string - name: created_by_id in: query description: '' required: false type: string - name: created_by in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: assigned_object_type_id__n in: query description: '' required: false type: string - name: assigned_object_id__n in: query description: '' required: false type: string - name: assigned_object_id__lte in: query description: '' required: false type: string - name: assigned_object_id__lt in: query description: '' required: false type: string - name: assigned_object_id__gte in: query description: '' required: false type: string - name: assigned_object_id__gt in: query description: '' required: false type: string - name: kind__n in: query description: '' required: false type: string - name: last_updated__n in: query description: '' required: false type: string - name: last_updated__lte in: query description: '' required: false type: string - name: last_updated__lt in: query description: '' required: false type: string - name: last_updated__gte in: query description: '' required: false type: string - name: last_updated__gt in: query description: '' required: false type: string - name: tag__n in: query description: '' required: false type: string - name: assigned_object_type__n in: query description: '' required: false type: string - name: created_by_id__n in: query description: '' required: false type: string - name: created_by__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/JournalEntry' tags: - extras post: operationId: extras_journal-entries_create description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableJournalEntry' responses: '201': description: '' schema: $ref: '#/definitions/JournalEntry' tags: - extras put: operationId: extras_journal-entries_bulk_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableJournalEntry' responses: '200': description: '' schema: $ref: '#/definitions/JournalEntry' tags: - extras patch: operationId: extras_journal-entries_bulk_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableJournalEntry' responses: '200': description: '' schema: $ref: '#/definitions/JournalEntry' tags: - extras delete: operationId: extras_journal-entries_bulk_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: [] /extras/journal-entries/{id}/: get: operationId: extras_journal-entries_read description: '' parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/JournalEntry' tags: - extras put: operationId: extras_journal-entries_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableJournalEntry' responses: '200': description: '' schema: $ref: '#/definitions/JournalEntry' tags: - extras patch: operationId: extras_journal-entries_partial_update description: '' parameters: - name: data in: body required: true schema: $ref: '#/definitions/WritableJournalEntry' responses: '200': description: '' schema: $ref: '#/definitions/JournalEntry' tags: - extras delete: operationId: extras_journal-entries_delete description: '' parameters: [] responses: '204': description: '' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this journal entry. required: true type: integer /extras/object-changes/: get: operationId: extras_object-changes_list description: Retrieve a list of recent changes. parameters: - name: id in: query description: '' required: false type: string - name: user in: query description: '' required: false type: string - name: user_name in: query description: '' required: false type: string - name: request_id in: query description: '' required: false type: string - name: action in: query description: '' required: false type: string - name: changed_object_type_id in: query description: '' required: false type: string - name: changed_object_id in: query description: '' required: false type: string - name: object_repr in: query description: '' required: false type: string - name: q in: query description: '' required: false type: string - name: time in: query description: '' required: false type: string - name: changed_object_type in: query description: '' required: false type: string - name: user_id in: query description: '' required: false type: string - name: id__n in: query description: '' required: false type: string - name: id__lte in: query description: '' required: false type: string - name: id__lt in: query description: '' required: false type: string - name: id__gte in: query description: '' required: false type: string - name: id__gt in: query description: '' required: false type: string - name: user__n in: query description: '' required: false type: string - name: user_name__n in: query description: '' required: false type: string - name: user_name__ic in: query description: '' required: false type: string - name: user_name__nic in: query description: '' required: false type: string - name: user_name__iew in: query description: '' required: false type: string - name: user_name__niew in: query description: '' required: false type: string - name: user_name__isw in: query description: '' required: false type: string - name: user_name__nisw in: query description: '' required: false type: string - name: user_name__ie in: query description: '' required: false type: string - name: user_name__nie in: query description: '' required: false type: string - name: user_name__empty in: query description: '' required: false type: string - name: action__n in: query description: '' required: false type: string - name: changed_object_type_id__n in: query description: '' required: false type: string - name: changed_object_id__n in: query description: '' required: false type: string - name: changed_object_id__lte in: query description: '' required: false type: string - name: changed_object_id__lt in: query description: '' required: false type: string - name: changed_object_id__gte in: query description: '' required: false type: string - name: changed_object_id__gt in: query description: '' required: false type: string - name: object_repr__n in: query description: '' required: false type: string - name: object_repr__ic in: query description: '' required: false type: string - name: object_repr__nic in: query description: '' required: false type: string - name: object_repr__iew in: query description: '' required: false type: string - name: object_repr__niew in: query description: '' required: false type: string - name: object_repr__isw in: query description: '' required: false type: string - name: object_repr__nisw in: query description: '' required: false type: string - name: object_repr__ie in: query description: '' required: false type: string - name: object_repr__nie in: query description: '' required: false type: string - name: object_repr__empty in: query description: '' required: false type: string - name: changed_object_type__n in: query description: '' required: false type: string - name: user_id__n in: query description: '' required: false type: string - name: ordering in: query description: Which field to use when ordering the results. required: false type: string - name: limit in: query description: Number of results to return per page. required: false type: integer - name: offset in: query description: The initial index from which to return the results. required: false type: integer responses: '200': description: '' schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri x-nullable: true previous: type: string format: uri x-nullable: true results: type: array items: $ref: '#/definitions/ObjectChange' tags: - extras parameters: [] /extras/object-changes/{id}/: get: operationId: extras_object-changes_read description: Retrieve a list of recent changes. parameters: [] responses: '200': description: '' schema: $ref: '#/definitions/ObjectChange' tags: - extras parameters: - name: id in: path description: A unique integer value identifying this object change. required: true type: integer /extras/reports/: get: operationId: extras_reports_list description: Compile all reports and their related results (if any). Result data is deferred in the list view. parameters: [] responses: '200': description: '' tags: - extras parameters: [] /extras/reports/{id}/: get: operationId: extras_reports_read description: Retrieve a single Report identified as ".". parameters: [] responses: '200': description: '' tags: - extras parameters: - name: id in: path required: true type: string /extras/reports/{id}/run/: post: operationId: extras_reports_run description: Run a Report identified as ".